Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Persons

Update a personal identifier

Update a personal identifier, e.g. SSN, for this customer

patch/persons/personal_ids/{personal_id_id}

Path parameters

personal_id_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

UUID for a personal identifier.

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

country_codestring

The updated ISO 3166 Alpha-2 country code for the country that issued the personal identifier. The country code cannot be modified for personal identifier types that have an implicit country, e.g. SSN.

expiry_datestring date

The date the associated document is set to expire on set by the governing authority.

id_type'CITIZENSHIP_CARD' | 'DRIVER_LICENSE' | 'ITIN' | 'NATIONAL_ID' | 'PASSPORT_NUMBER' | 'PROVINCIAL_ID' | 'PR_CARD' | 'SECURE_STATUS_CARD' | 'SIN' | 'SSN' | 'STATE_ID' | 'TAX_ID' required

The type of the personal identifier. This cannot be changed once the personal identifier is created. One of the following:

  • ITIN - US Individual Tax Identification Number. Format is 987-65-4321. Country code will default to US.
  • PASSPORT_NUMBER - Passport Number. Format varies by country. Country code is required.
  • SIN - Canadian Social Insurance Number. Format is 123-456-789. Country code will default to CA.
  • SSN - US Social Security Number. Format is 123-45-6789. Country code will default to US.
  • DRIVER_LICENSE - Driver License Number. Format varies by country and state.
  • STATE_ID - US State ID Number. Format varies by state.
  • NATIONAL_ID - National ID Number. Format varies by country.
  • TAX_ID - Tax ID Number. Format varies by country.
  • CITIZENSHIP_CARD - Canadian Citizenship Card Number. Format is A1234567.
  • PR_CARD - Permanent Resident Card Number. Format varies by country.
  • PROVINCIAL_ID - Canadian Provincial ID Number. Format varies by province.
  • SECURE_STATUS_CARD - Canadian Secure Status Card Number. Format is 1998-12-123456.
identifierstring

The updated personal identifier

issue_datestring date

The date the associated document was issued by the governing authority.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example request

{
  "country_code": "US",
  "expiry_date": "2020-01-01",
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "issue_date": "2020-01-01",
  "tenant": "abcdef_ghijkl"
}

Response

Created personal identifier.

customer_idstring uuid required

Id of the customer having this personal identifier

country_codestring US required

The ISO 3166 Alpha-2 country code for the country that issued the personal identifier.

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

idstring uuid required

UUID for the personal identifier for subsequent changes and deletion

id_type'CITIZENSHIP_CARD' | 'DRIVER_LICENSE' | 'ITIN' | 'NATIONAL_ID' | 'PASSPORT_NUMBER' | 'PROVINCIAL_ID' | 'PR_CARD' | 'SECURE_STATUS_CARD' | 'SIN' | 'SSN' | 'STATE_ID' | 'TAX_ID' required

The type of the personal identifier. This cannot be changed once the personal identifier is created. One of the following:

  • ITIN - US Individual Tax Identification Number. Format is 987-65-4321. Country code will default to US.
  • PASSPORT_NUMBER - Passport Number. Format varies by country. Country code is required.
  • SIN - Canadian Social Insurance Number. Format is 123-456-789. Country code will default to CA.
  • SSN - US Social Security Number. Format is 123-45-6789. Country code will default to US.
  • DRIVER_LICENSE - Driver License Number. Format varies by country and state.
  • STATE_ID - US State ID Number. Format varies by state.
  • NATIONAL_ID - National ID Number. Format varies by country.
  • TAX_ID - Tax ID Number. Format varies by country.
  • CITIZENSHIP_CARD - Canadian Citizenship Card Number. Format is A1234567.
  • PR_CARD - Permanent Resident Card Number. Format varies by country.
  • PROVINCIAL_ID - Canadian Provincial ID Number. Format varies by province.
  • SECURE_STATUS_CARD - Canadian Secure Status Card Number. Format is 1998-12-123456.
identifierstring required

The personal identifier. Format varies by personal identifier type.

system_providedboolean required

True if the identifier was provided by the system, e.g. via SSN Prefill.

expiry_datestring date

The date the associated document is set to expire on set by the governing authority.

issue_datestring date

The date the associated document was issued by the governing authority.

Example response

{
  "customer_id": "21943c51-e4ff-4e57-9558-08cab6b963fe",
  "tenant": "abcdef_ghijkl",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "expiry_date": "2020-01-01",
  "issue_date": "2020-01-01"
}