POST /cra/loans/register

/cra/loans/register registers a list of loans to their applicants.

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
`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.
`loans[]`	Array	Yes	A list of loans to register.
`loans[].opened_with_status`	Object	Yes	Contains the status and date information of the loan when registering.
`loans[].opened_with_status.status`	String	Yes	The status of the loan. Valid values: `"DEFAULT"` `"OTHER"` `"TRANSFERRED"` `"CURRENT"` `"PAID_OFF"` `"BOOKED"` `"CHARGED_OFF"` `"DECLINED"` `"APPROVED"` `"DELINQUENT"`
`loans[].opened_with_status.date`	String	Yes	The effective date for the status of the loan. The date should be in ISO 8601 format (YYYY-MM-DD).
`loans[].loan_amount`	Number	No	The total amount of the approved loan.
`loans[].application`	Object	No	Contains loan application data to register.
`loans[].application.application_date`	String	No	The date the user applied for the loan. The date should be in ISO 8601 format (YYYY-MM-DD).
`loans[].application.application_id`	String	No	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`.
`loans[].user_token`	String	Yes	The user token for the user associated with the loan.
`loans[].payment_schedule`	String	Yes	The frequency of a loan's payment schedule. `BIWEEKLY` represents one payment every two weeks. Valid values: `"OTHER"` `"QUARTERLY"` `"ANNUALLY"` `"DAILY"` `"WEEKLY"` `"MONTHLY"` `"BIWEEKLY"`
`loans[].opened_date`	String	Yes	The date the loan account was opened. The date should be in ISO 8601 format (YYYY-MM-DD).
`loans[].type`	String	Yes	The type of loan the user applied for. Valid values: `"HOME_EQUITY"` `"OTHER"` `"AUTO"` `"PERSONAL"` `"MORTGAGE"` `"CREDIT_CARD"` `"PAYDAY"` `"STUDENT"` `"BUSINESS"`
`loans[].loan_id`	String	Yes	A unique identifier for the loan. Personally identifiable information, such as an email address or phone number, should not be used in the `loan_id`.
`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.