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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`name`	Object	No	The person's legal name
`name.family_name`	String	Yes	A string with at least one non-whitespace character, with a max length of 100 characters.
`name.given_name`	String	Yes	A string with at least one non-whitespace character, with a max length of 100 characters.
`date_of_birth`	String	No	The date of birth of the person. Formatted as YYYY-MM-DD.
`email_address`	String	No	A valid email address. Must not have leading or trailing spaces.
`client_id`	String	No	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.
`relationship_to_originator`	String	No	The relationship between this person and the originator they are related to.
`ownership_percentage`	Integer	No	The percentage of ownership this person has in the onboarding business. Only applicable to beneficial owners with 25% or more ownership.
`id_number`	Object	No	ID number of the person
`id_number.type`	String	Yes	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. Possible values: `"sg_nric"` `"se_pin"` `"cl_run"` `"ke_huduma_namba"` `"ca_sin"` `"es_nie"` `"za_smart_id"` `"ng_nin"` `"es_dni"` `"om_civil_id"` `"ar_dni"` `"jo_civil_id"` `"kw_civil_id"` `"mx_rfc"` `"eg_national_id"` `"dk_cpr"` `"jp_my_number"` `"in_pan"` `"nz_drivers_license"` `"tr_tc_kimlik"` `"cn_resident_card"` `"mx_curp"` `"br_cpf"` `"sa_national_id"` `"us_ssn_last_4"` `"au_passport"` `"co_nit"` `"ph_psn"` `"hk_hkid"` `"pl_pesel"` `"my_nric"` `"ro_cnp"` `"us_ssn"` `"it_cf"` `"au_drivers_license"`
`id_number.value`	String	Yes	Value of the person's ID Number. Alpha-numeric, with all formatting characters stripped.
`secret`	String	No	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.
`address`	Object	No	Home address of a person
`address.street2`	String	No	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.
`address.region`	String	Yes	An ISO 3166-2 subdivision code. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc.
`address.postal_code`	String	Yes	The postal code of the address.
`address.country`	String	Yes	Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
`address.street`	String	Yes	The primary street portion of an address. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
`address.city`	String	Yes	The full city name.
`originator_client_id`	String	Yes	The client ID of the originator
`phone_number`	String	No	A valid phone number in E.164 format.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.