Get Doc Requirements

post

https://dispute-api-{corename}.{env}.gpsrv.com/getDocRequirements

👍
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

Form Data

apiLogin

string

required

Provider's web service username, as provided by Galileo for the requesting IP address.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo for the requesting IP address.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued unique provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A provider-generated ID that is unique to each API call. A UUID is preferred. Do not reuse this identifier for multiple API calls.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

caseId

string

required

^$|^([0-9]{11}[A-Z]{1})$

Case identifier as returned by Create Case.
Pattern: Max 11 digits with a letter
Example: "22021000017C"

Response

default