Get status of an originator's onboarding

POST /transfer/originator/get

The /transfer/originator/get endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.

Request Body

Required

Defines the request schema for /transfer/originator/get

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
Client ID of the end customer (i.e. the originator).

Response

Defines the response schema for /transfer/originator/get

Response Properties

originator
required, object
Originator and their status.
client_id
required, string
Originator’s client ID.
transfer_diligence_status
required, string
Originator’s diligence status.
company_name
required, string
The company name of the end customer.
outstanding_requirements
array[object]
List of outstanding requirements for scaled platform originators. Only populated when transfer_diligence_status is more_information_required.
requirement_type
string
The type of requirement.
person_id
string
UUID of the person associated with the requirement. Only present for individual-scoped requirements.
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.