getstarted.ae

Update a person

PATCHhttps://api.getstarted.ae/v1/customers/{customerId}/persons/{personId}

Updates the fields you send. Omitted fields are unchanged; residentialAddress is replaced whole.

Path parameters

  • customerIdstringrequired

    ID of the customer, e.g. cus_01J9ZK4R7Q2M8X.

  • personIdstringrequired

    ID of the person, e.g. per_01J9ZKA1M4HD2T.

Body parameters

  • firstNamestring

    Given name as it appears on the passport.

  • lastNamestring

    Family name as it appears on the passport.

  • dateOfBirthstring (date)

    YYYY-MM-DD.

  • nationalitystring

    ISO 3166-1 alpha-2 country code.

  • emailstring

    Contact email. Some jurisdictions send e-signature requests here.

  • phonestring

    E.164 format, e.g. +447700900123.

  • residentialAddressobject

    Home address. Required for directors in most jurisdictions.

    • residentialAddress.line1stringrequired

      Street address.

    • residentialAddress.line2string

      Unit, floor or building.

    • residentialAddress.citystringrequired

      City or town.

    • residentialAddress.regionstring

      State, province or emirate.

    • residentialAddress.postalCodestring

      Postal or ZIP code. Required where the country uses one.

    • residentialAddress.countrystringrequired

      ISO 3166-1 alpha-2 country code.

  • metadataobject

    Up to 20 string key-value pairs for your own use.

Responses

  • 200OK. Returns the object shown in the example.
  • 400unknown_field The body contains a key the endpoint does not accept.
  • 404resource_not_found No person with that ID exists in this environment.
  • 422invalid_value A value fails type or format validation.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X PATCH "https://api.getstarted.ae/v1/customers/cus_01J9ZK4R7Q2M8X/persons/per_01J9ZKA1M4HD2T" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+447700900456"
}'
Response · 200
{
  "id": "per_01J9ZKA1M4HD2T",
  "object": "person",
  "customerId": "cus_01J9ZK4R7Q2M8X",
  "firstName": "Maya",
  "lastName": "Okafor",
  "dateOfBirth": "1989-04-17",
  "nationality": "GB",
  "email": "maya@northwindlabs.com",
  "phone": "+447700900456",
  "residentialAddress": {
    "line1": "42 Elm Street",
    "line2": null,
    "city": "London",
    "region": null,
    "postalCode": "N1 7GU",
    "country": "GB"
  },
  "createdAt": "2026-09-20T08:20:03Z",
  "updatedAt": "2026-09-21T10:00:00Z"
}