Availability
No new clients will be set up with Dispute API 2.0. Legacy clients will eventually be migrated to Dispute API 3.0.
Use the Get Doc Requirements endpoint to retrieve any required documents for the account holder to fill out, depending on the nature of the dispute. If there is a document to fill out, this endpoint returns a templateDocumentStream of a PDF form for the account holder to fill out.
This endpoint is part of a conversational API—a series of endpoint calls that must be made in a certain order. If you call this endpoint, it must be during the intake flow; you cannot call it after the case has been submitted. To get the required documents for a case that has already been submitted, use the Get Documents endpoint.
For instructions see the Creating an API 2.0 Dispute guide.
- Previous endpoint: Add Questionnaire
- Next endpoint: Add Required Docs
Status codes
See Global Response Statuses for status codes that are common across endpoints.
The table below lists status codes that apply to this specific endpoint.
| Status code | Description |
|---|---|
| 1508-4 | Invalid case ID or case ID returned no results |
| 1508-5 | Invalid request |
| 1508-13 | caseId references a case that is currently locked |
| 1508-14 | Invalid request message |