PATCH
/
deliver
/
persons
/
{id}
curl --request PATCH \
  --url https://api-sandbox.orum.io/deliver/persons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "<string>",
  "social_security_number": "<string>",
  "addresses": [
    {
      "type": "home",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>"
    }
  ],
  "contacts": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "metadata": {}
}'
{
  "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

​
Authorization
string
header
required

The auth token received from Authentication endpoints.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

​
id
string
required

Orum generated unique id for the resource for the person resource you are updating.

Body

application/json
​
first_name
string

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255
​
middle_name
string

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Maximum length: 255
​
last_name
string

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255
​
date_of_birth
string

Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and greater than 18 years to be verified.

​
social_security_number
string | null

Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) in XXX-XX-XXXX format. An example dummy value is 123-45-6789. Note: This field is required for payouts, deposits, or account-to-account transfers.

​
addresses
object[] | null

Address information for the person. "type" is required if you are updating other address fields. Note: This field is required for payouts, deposits, or account-to-account transfers.

Address.

​
contacts
object[] | null

Optional list of contact information for the person. If object is present, either phone and/or email contact types are accepted. A maximum of three persons or businesses can have the same phone number.

Contact information.

​
metadata
object

Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.

Response

200
application/json
200 response.
​
person
object
required

Was this page helpful?

Update Person By Customer Reference IDClose Person By ID