Create a person associated with an originator

POST /transfer/platform/person/create

Use the /transfer/platform/person/create endpoint to create a person record associated with an originator and optionally submit person-specific requirements.

Request Body

Required

Defines the request schema for /transfer/platform/person/create

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
originator_client_id
required, string
The client ID of the originator
name
object
The person’s legal name
given_name
required, string
A string with at least one non-whitespace character, with a max length of 100 characters.
family_name
required, string
A string with at least one non-whitespace character, with a max length of 100 characters.
email_address
string
A valid email address. Must not have leading or trailing spaces.
phone_number
string
A valid phone number in E.164 format. Phone number input may be validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment.
address
object
Home address of a person
city
required, string
The full city name.
country
required, string
Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
postal_code
required, string
The postal code of the address.
region
required, string
An ISO 3166-2 subdivision code. Related terms would be “state”, “province”, “prefecture”, “zone”, “subdivision”, etc.
street
required, string
The primary street portion of an address. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
street2
string
Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 50 characters.
id_number
object
ID number of the person
value
required, string
Value of the person’s ID Number. Alpha-numeric, with all formatting characters stripped.
type
required, string
A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see Hybrid Input Validation.
date_of_birth
string
The date of birth of the person. Formatted as YYYY-MM-DD.
relationship_to_originator
string
The relationship between this person and the originator they are related to.
ownership_percentage
integer
The percentage of ownership this person has in the onboarding business. Only applicable to beneficial owners with 25% or more ownership.
title
string
The title of the person at the business. Only applicable to control persons - for example, “CEO”, “President”, “Owner”, etc.

Response

Defines the response schema for /transfer/platform/person/create

Response Properties

request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
person_id
required, string
An ID that should be used when submitting additional requirements that are associated with this person.