POST /cra/loans/applications/register

/cra/loans/applications/register registers loan applications and decisions.

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
`applications[]`	Array	Yes	A list of loan applications to register.
`applications[].user_token`	String	Yes	The user token for the user associated with the loan.
`applications[].application_date`	String	No	The date the user applied for the loan. The date should be in ISO 8601 format (YYYY-MM-DD).
`applications[].decision_date`	String	No	The date when the loan application's decision was made. The date should be in ISO 8601 format (YYYY-MM-DD).
`applications[].application_id`	String	Yes	A unique identifier for the loan application. Personally identifiable information, such as an email address or phone number, should not be used in the `application_id`.
`applications[].type`	String	Yes	The type of loan the user applied for. Valid values: `"HOME_EQUITY"` `"OTHER"` `"AUTO"` `"PERSONAL"` `"MORTGAGE"` `"CREDIT_CARD"` `"PAYDAY"` `"STUDENT"` `"BUSINESS"`
`applications[].decision`	String	Yes	The decision of the loan application. Valid values: `"OTHER"` `"DECLINED"` `"APPROVED"`
`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.
`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.

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.