Create a person

Create a person who may act as a personal customer or a director/officer/owner of a business. 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

Details of a person

is_customer · boolean · required

True for personal and business customers with a direct relationship with the fintech or bank. Set this to true for any customer related to an account.

Example:

true

status · enum<string> · required

Status of the person. One of the following:

• ACTIVE – is an integrator defined status. Integrators should set a person to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the person is eligible for specific actions such as initiating transactions or issuing a card.
• DECEASED – person is deceased.
• DENIED – customer was turned down.
• DORMANT – person is no longer active.
• ESCHEAT – person's assets are abandoned and are property of the state.
• FROZEN – person's actions are blocked for security, legal, or other reasons.
• INACTIVE – an inactive status indicating that the person is no longer active.
• PROSPECT – a potential customer, used for information-gathering and disclosures.
• SANCTION – person is on a sanctions list and should be carefully monitored.

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

Example:

"ACTIVE"

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"

chosen_name · string

Person's chosen name.

Example:

"Annie"

dob · string<date>

Person'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"

email · string

Person's email.

Example:

"[e-mail]"

first_name · string

Person's first name.

Example:

"Jane"

last_name · string

Person's last name.

Example:

"Smith"

legal_address · object

Legal address

Show child attributes

metadata · object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

middle_name · string

Person's middle name.

Example:

"Anne"

phone_number · string

Person'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]"

shipping_address · object

Shipping address

Show child attributes

ssn · string

Person's full tax ID eg SSN formatted with hyphens. 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"

personal_ids · object[]

Array of personal identifiers

Show child attributes

note · string

Text to be added to a note when creating a person. A note is required when creating a person with a ban_status of SUSPENDED.

Response

201

application/json

Created person representation.

Details of a person

ban_status · enum<string> · required

(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> · required

The date and time the resource was created.

Example:

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

id · string<uuid> · required

Person's unique identifier.

Example:

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

is_customer · boolean · required

True for personal and business customers with a direct relationship with the fintech or bank. Set this to true for any customer related to an account.

Example:

true

last_updated_time · string<date-time> · required

The date and time the resource was last updated.

Example:

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

status · enum<string> · required

Status of the person. One of the following:

• ACTIVE – is an integrator defined status. Integrators should set a person to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the person is eligible for specific actions such as initiating transactions or issuing a card.
• DECEASED – person is deceased.
• DENIED – customer was turned down.
• DORMANT – person is no longer active.
• ESCHEAT – person's assets are abandoned and are property of the state.
• FROZEN – person's actions are blocked for security, legal, or other reasons.
• INACTIVE – an inactive status indicating that the person is no longer active.
• PROSPECT – a potential customer, used for information-gathering and disclosures.
• SANCTION – person is on a sanctions list and should be carefully monitored.

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

Example:

"ACTIVE"

tenant · string · required

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

Example:

"abcdef_ghijkl"

verification_status · enum<string> · required

The result of a KYC/KYB verification. One of the following:

• UNVERIFIED – verification has not been completed for this customer.
• PENDING – verification is in progress for this customer.
• PROVISIONAL – partially verified or verified with restrictions.
• ACCEPTED – the customer has been verified.
• REVIEW – verification has run and issues have been identified and require review.
• REJECTED – the customer was rejected and should not be allowed to take certain actions e.g., open an account.

Available options:

ACCEPTED,

PENDING,

PROVISIONAL,

REJECTED,

REVIEW,

UNVERIFIED

Example:

"ACCEPTED"

chosen_name · string

Person's chosen name.

Example:

"Annie"

dob · string<date>

Person'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"

email · string

Person's email.

Example:

"[e-mail]"

first_name · string

Person's first name.

Example:

"Jane"

has_accounts · boolean

This flag indicates whether the person or business has accounts.

last_name · string

Person's last name.

Example:

"Smith"

legal_address · object

Legal address

Show child attributes

metadata · object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

middle_name · string

Person's middle name.

Example:

"Anne"

phone_number · string

Person'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]"

shipping_address · object

Shipping address

Show child attributes

ssn · string

Person's full tax ID eg SSN formatted with hyphens. 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

verification_last_run · string<date-time>

Date and time KYC verification was last run on the person.

Example:

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

personal_ids · object[]

Array of personal identifiers

Show child attributes