People

The People API allows you to manage people's identities independently. If you do not create people associated with merchants at the time of boarding, you may be required to provide this information further in the merchant's lifecycle.

Creating People

Required Fields: firstName, lastName, birthDate, and address

{
  "reference": "PER005",
  "firstName": "Robert",
  "lastName": "Smith",
  "birthDate": "1990-12-15",
  "email": "[email protected]",
  "address": {
    "street": "321 Oak Lane",
    "city": "Austin",
    "region": "TX",
    "postalCode": "73301",
    "country": "US"
  }
}

Linking People to a Merchant

If you created people and merchants separately, or need to add a new person to an existing merchant, you can use the merchants endpoint to associate a person to the merchant.

{
  "personId": "person_abcdefghijklmno123456",
  "relationshipType": "DIRECTOR"
}

Updating, Listing & Removing People

Similar to the function for a merchant, the People endpoint supports PATCH calls to update any people's data.