Skip to main content
POST
/
persons
/
personal_ids
Create a personal identifier
curl --request POST \
  --url https://api.synctera.com/v2/persons/personal_ids \
  --header 'Content-Type: application/json' \
  --data '{
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "country_code": "<string>",
  "customer_id": "21943c51-e4ff-4e57-9558-08cab6b963fe",
  "expiry_date": "2020-01-01",
  "issue_date": "2020-01-01",
  "tenant": "abcdef_ghijkl"
}'
{
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "system_provided": true,
  "country_code": "<string>",
  "customer_id": "21943c51-e4ff-4e57-9558-08cab6b963fe",
  "expiry_date": "2020-01-01",
  "issue_date": "2020-01-01",
  "tenant": "abcdef_ghijkl"
}

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json
​
id_type
enum<string>
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.
Available options:
ITIN,
PASSPORT_NUMBER,
SIN,
SSN,
DRIVER_LICENSE,
STATE_ID,
NATIONAL_ID,
TAX_ID,
CITIZENSHIP_CARD,
PR_CARD,
PROVINCIAL_ID,
SECURE_STATUS_CARD
Example:

"SSN"

​
identifier
string
required

The personal identifier. Format varies by personal identifier type.

Example:

"123-45-6789"

​
customer_id
string<uuid>
required

Id of the customer having this personal identifier

Example:

"21943c51-e4ff-4e57-9558-08cab6b963fe"

​
expiry_date
string<date>

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

Example:

"2020-01-01"

​
issue_date
string<date>

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

Example:

"2020-01-01"

​
country_code
string<US>

The ISO 3166 Alpha-2 country code for the country that issued the personal identifier. This is optional for personal identifier types that have an implicit country, e.g. SSN. This is required for other types, e.g. PASSPORT_NUMBER.

​
tenant
string

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

Example:

"abcdef_ghijkl"

Response

Created personal identifier.

​
id
string<uuid>
required

UUID for the personal identifier for subsequent changes and deletion

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
id_type
enum<string>
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.
Available options:
ITIN,
PASSPORT_NUMBER,
SIN,
SSN,
DRIVER_LICENSE,
STATE_ID,
NATIONAL_ID,
TAX_ID,
CITIZENSHIP_CARD,
PR_CARD,
PROVINCIAL_ID,
SECURE_STATUS_CARD
Example:

"SSN"

​
identifier
string
required

The personal identifier. Format varies by personal identifier type.

Example:

"123-45-6789"

​
system_provided
boolean
required

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

​
customer_id
string<uuid>
required

Id of the customer having this personal identifier

Example:

"21943c51-e4ff-4e57-9558-08cab6b963fe"

​
country_code
string<US>
required

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

​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
expiry_date
string<date>

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

Example:

"2020-01-01"

​
issue_date
string<date>

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

Example:

"2020-01-01"