POST /cra/loans/unregister

/cra/loans/unregister indicates the loans have reached a final status and no further updates are expected.

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 unregister.
`loans[].closed_with_status`	Object	Yes	Contains the status and date information of the loan when unregistering.
`loans[].closed_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[].closed_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_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.