Skip to main content
PATCH
/
v1
/
identities
/
personal
/
{id}
Update a Personal Identity
curl --request PATCH \
  --url https://sandbox-api.borderless.xyz/v1/identities/personal/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "secondLastName": "Smith",
  "middleName": "Michael",
  "taxId": "123456789",
  "dateOfBirth": "2003-01-01",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "activity": "Software Engineer",
  "sex": "Male",
  "address": {
    "street1": "123 Main St",
    "city": "New York",
    "country": "US",
    "postalCode": "10001",
    "street2": "Apt 4B",
    "state": "NY"
  }
}
'
{
  "id": "<string>",
  "type": "Personal",
  "status": "Active",
  "suspensionReason": "<string>",
  "deleted": true,
  "hasComplianceChecks": true,
  "data": {
    "firstName": "<string>",
    "lastName": "<string>",
    "secondLastName": "<string>",
    "middleName": "<string>",
    "taxId": "<string>",
    "dateOfBirth": "YYYY-MM-DD",
    "email": "<string>",
    "phone": "<string>",
    "activity": "<string>",
    "sex": "Male",
    "address": {
      "id": "<string>",
      "street1": "<string>",
      "street2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "AF",
      "postalCode": "<string>"
    },
    "documents": [
      {
        "id": "<string>",
        "issuingCountry": "AF",
        "type": "Passport",
        "idNumber": "<string>",
        "issuedDate": "YYYY-MM-DD",
        "expiryDate": "YYYY-MM-DD"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
firstName
string

The first name of the person

Required string length: 2 - 100
Example:

"John"

​
lastName
string

The last name of the person

Required string length: 2 - 100
Example:

"Doe"

​
secondLastName
string

The second last name of the person

Required string length: 1 - 100
Example:

"Smith"

​
middleName
string

The middle name of the person

Required string length: 1 - 100
Example:

"Michael"

​
taxId
string

The tax identification number of the person

Required string length: 3 - 20
Example:

"123456789"

​
dateOfBirth
string<date>

The date of birth of the person in format yyyy-mm-dd

Example:

"2003-01-01"

​
email
string<email>

The email address of the person

Example:

"john.doe@example.com"

​
phone
string

The phone number of the person

Required string length: 7 - 20
Example:

"+1234567890"

​
activity
string

The activity or occupation of the person

Required string length: 1 - 255
Example:

"Software Engineer"

​
sex
enum<string>

The sex of the person

Available options:
Male,
Female
Example:

"Male"

​
address
object

The address of the person

Response

​
id
string
required
​
type
enum<string>
required
Available options:
Personal,
Business
​
status
enum<string>
required
Available options:
Active,
Inactive,
Suspended
​
suspensionReason
string | null
required
​
deleted
boolean
required
​
hasComplianceChecks
boolean
required
​
data
object
required
  • Option 1
  • Option 2