Sign in

v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Persons

Create persons

Creates one or more persons for the given customer. Insert-only; existing persons cannot be updated. Only available before compliance is completed.

post/v4/customers/{customerId}/persons

Path parameters

customerIdstring required

The Slope customer ID or the partner external customer ID

Request body

Example request

{
  "persons": [
    {
      "address": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "country": "US",
        "state": "CA",
        "postalCode": "94107"
      }
    }
  ]
}

Response

The created persons.

idstring required
customerIdstring required
firstNamestring
lastNamestring
dobstring
isApplicantboolean required
isOwnerboolean required
isControllerboolean required
titlestring
emailstring
phonestring

Example response

{
  "address": {
    "line1": "123 Main St",
    "city": "San Francisco",
    "country": "US",
    "state": "CA",
    "postalCode": "94107"
  }
}