provider plaid POST /transfer/platform/person/create
@utdk/plaid /transfer/platform/person/create
Create a person associated with an originator
Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them.

Try it

Authentication
Configure credentials for The Plaid API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

transferplatformpersoncreate
POST/transfer/platform/person/create
Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them.

Input

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.

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.

required

The client ID of the originator

The person's legal name

A valid email address. Must not have leading or trailing spaces.

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.

Home address of a person

ID number of the person

The date of birth of the person. Formatted as YYYY-MM-DD.

The relationship between this person and the originator they are related to.

The percentage of ownership this person has in the onboarding business. Only applicable to beneficial owners with 25% or more ownership.

The title of the person at the business. Only applicable to control persons - for example, "CEO", "President", "Owner", etc.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.transferplatformpersoncreate()