Persons
Close Person By ID
Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Schedules
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Persons
Close Person By ID
Close a person object so they are unable to transact.
DELETE
/
deliver
/
persons
/
{id}
curl --request DELETE \
--url https://api-sandbox.orum.io/deliver/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"person": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_reference_id": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"status": "created",
"addresses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "home",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip5": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"contacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status_reasons": [
{
"reason_code": "invalid_address",
"reason_code_message": "Address submitted is a non-supported address type"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver API. Use v2022-09-21.
Available options:
v2022-09-21
Path Parameters
Orum generated unique id for the resource for the person resource you are updating.
Response
200
application/json
200 response.
The response is of type object
.
Was this page helpful?
curl --request DELETE \
--url https://api-sandbox.orum.io/deliver/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"person": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_reference_id": "<string>",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"status": "created",
"addresses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "home",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip5": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"contacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"value": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status_reasons": [
{
"reason_code": "invalid_address",
"reason_code_message": "Address submitted is a non-supported address type"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {}
}
}