Create a Customer

The customer object represents your customer’s identity. You can then verify the identity of this customer and associate them with other people and accounts. Note that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Customer to create

Customer

Details of a customer

status · enum<string> · required

Customer's status

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

ban_status · enum<string>

(beta) Ban status of the person. One of the following:

• ALLOWED – person is not banned or suspended
• SUSPENDED - person is manually suspended due to fraud
• BANNED – person is banned due to matching ban rules Note: changing the ban status to or from BANNED can only be performed by the Synctera platform based on ban rules.

Available options:

ALLOWED,

BANNED,

SUSPENDED

Example:

"ALLOWED"

email · string

Customer's email

Example:

"[e-mail]"

legal_address · object

Legal address

Show child attributes

metadata · object

User-supplied metadata. Do not use to store PII.

middle_name · string

Customer's middle name

Example:

"Anne"

note · string

Add an optional note when creating or updating a customer. A note is required when updating a customers's ban_status between SUSPENDED and ALLOWED.

phone_number · string

Customer's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.

Example:

"[phone]"

related_customers · Relationship · object[] · deprecated

Customer's relationships with other accounts eg. guardian. This property is no longer supported. Setting it will return an error.

Show child attributes

shipping_address · object

Shipping address

Show child attributes

ssn · string

Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\d{3}-\d{2}-\d{4}$. The response contains the last 4 digits only (e.g. 6789).

Example:

"123-45-6789"

tenant · string

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

Example:

"abcdef_ghijkl"

dob · string<date>

Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD). Must be on or after 1900-01-01 and before current date.

Example:

"2000-01-01"

first_name · string

Customer's first name

Example:

"Jane"

last_name · string

Customer's last name

Example:

"Smith"

Response

201

application/json

Created customer

Customer

Details of a customer

status · enum<string> · required

Customer's status

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

addresses · object[]

All of the customer's addresses

Show child attributes

ban_status · enum<string>

(beta) Ban status of the person. One of the following:

• ALLOWED – person is not banned or suspended
• SUSPENDED - person is manually suspended due to fraud
• BANNED – person is banned due to matching ban rules Note: changing the ban status to or from BANNED can only be performed by the Synctera platform based on ban rules.

Available options:

ALLOWED,

BANNED,

SUSPENDED

Example:

"ALLOWED"

creation_time · string<date-time>

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

email · string

Customer's email

Example:

"[e-mail]"

has_accounts · boolean

This flag indicates whether the person or business has accounts.

id · string<uuid>

Customer unique identifier

Example:

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

kyc_exempt · boolean

Customer's KYC exemption

kyc_last_run · string<date-time>

Date and time KYC was last run on the customer

Example:

"2010-05-06T12:23:34.321Z"

kyc_status · enum<string>

Customer's KYC status

Available options:

ACCEPTED,

PENDING,

PROVIDER_FAILURE,

PROVISIONAL,

REJECTED,

REVIEW,

UNVERIFIED

last_updated_time · string<date-time>

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

legal_address · object

Legal address

Show child attributes

metadata · object

User-supplied metadata. Do not use to store PII.

middle_name · string

Customer's middle name

Example:

"Anne"

phone_number · string

Customer's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.

Example:

"[phone]"

related_customers · Relationship · object[] · deprecated

Customer's relationships with other accounts eg. guardian. This property is no longer supported. Setting it will return an error.

Show child attributes

shipping_address · object

Shipping address

Show child attributes

ssn · string

Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\d{3}-\d{2}-\d{4}$. The response contains the last 4 digits only (e.g. 6789).

Example:

"123-45-6789"

ssn_source · enum<string>

Describes the collection method for the customer's SSN:

• MANUAL – the full 9 digits of the customer's SSN was collected.
• PREFILL – the customer's SSN was collected using SSN Prefill.

Available options:

MANUAL,

PREFILL

tenant · string

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

Example:

"abcdef_ghijkl"

dob · string<date>

Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD). Must be on or after 1900-01-01 and before current date.

Example:

"2000-01-01"

first_name · string

Customer's first name

Example:

"Jane"

last_name · string

Customer's last name

Example:

"Smith"