This documentation is still a work in progress. Please contact Support to register for early access.
Return Credentials from Individual
Developing
POST
https://api.portierx.com/api/v1/access-credentials/return
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.portierx.com/api/v1/access-credentials/return' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"assignee": "22222222-2222-2222-2222-222222222222",
"occurred_at": "2025-07-11T09:00:00Z",
"credentials": [
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
],
"metadata": {
"condition": "good",
"notes": ""
}
}'Response Response Example
201 - Example 1
{
"msg": "Access Points successfully updated.",
"data": {
"credential": {
"id": "40f3c3f0-9cc5-4249-861c-5bbe541586cf",
"credential_id": "AC-20250709-001",
"name": "Main Server Room Badge"
},
"assigned_to": {
"id": "88537fcf-f516-41df-98ae-8e9a5e6f1da3",
"name": "Alexandra Kutch"
},
"issued_by": {
"id": "oGeq4Fdqnrn6MVty2ShUK",
"name": "Bert Crist"
},
"metadata": {
"condition": "Good",
"notes": "Returned on site."
},
"status": "returned",
"occurred_at": "2025-07-09T14:22:00+07:00",
"created_at": "2025-07-09T14:22:00+07:00"
}
}Modified at 2025-08-13 04:55:05