plaid

Create a person associated with an originator

Changed on

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.

post/transfer/platform/person/create

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/transfer/platform/person/create
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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_idstring required

The client ID of the originator

email_addressstring

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

phone_numberstring

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.

date_of_birthstring date

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

relationship_to_originatorstring

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

ownership_percentageinteger

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

titlestring

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

Example request

{
  "name": {
    "given_name": "Leslie",
    "family_name": "Knope"
  },
  "email_address": "user@example.com",
  "phone_number": "+12345678909",
  "id_number": {
    "value": "123456789",
    "type": "us_ssn"
  }
}

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

person_idstring required

An ID that should be used when submitting additional requirements that are associated with this person.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • a1bbca018160Revision changes
    • warning

      added the new ASSETS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

    • warning

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

    • warning

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

    • warning

      added the new ENRICH_ERROR enum value to the response property for the response status

    • warning

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

    • warning

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

    • warning

      added the new PROFILE_ERROR enum value to the response property for the response status

    • warning

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

    • warning

      added the new STATEMENTS_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

    • warning

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status