Submit onboarding requirements for Scaled Platform originators

POST /transfer/platform/requirement/submit

The /transfer/platform/requirement/submit endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.

Request Body

Required

Defines the request schema for /transfer/platform/requirement/submit

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
requirement_submissions
required, array[object]
A list of requirement submissions that all relate to the originator. Must contain between 1 and 50 requirement submissions.
requirement_type
required, string
The type of requirement being submitted
value
required, string
The value of the requirement, which can be a string or an object depending on the requirement_type. If it is an object, the object should be JSON marshaled into a string. See the documentation on this endpoint for more information and examples.
person_id
string
The person_id of the person the requirement submission is related to. A person_id is returned by /transfer/platform/person/create. This field should not be included for requirements that are not related to a person.

Response

Defines the response schema for /transfer/platform/requirement/submit

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.