Add Required Docs

post

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

👍
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 Add Required Docs endpoint to submit the PDF form that the account holder filled out, if a form was returned by Get Doc Requirements.

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 attach multiple documents with this endpoint, call the endpoint once for each document. If you need to attach documents after the case has been submitted, use the Add Documents endpoint.

For instructions see the Creating a Dispute guide.

Previous endpoint: Get Doc Requirements
Next endpoint: Optional. Get Case Summary

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"

documents

string

required

JSON array containing the required document and metadata. Pass only one document per endpoint call. See documents Subfields for the fields to include.
Pattern: JSON string
Example: [{"documentStream": "<Base64-encoded string>","identifier": "StatementOfDispute","attachmentCategory": "SupportingDocumentation","fileName": "StatementOfDispute.pdf","attachmentLabel": "Statement of Dispute"}]

Response

default