Add Document

post

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

👍
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 Document endpoint to attach a required document to the case, as specified in the response to the Get Requirements endpoint. Use this endpoint only after the dispute-intake process has been completed. During the dispute-intake process, use 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
1539-4	Invalid case ID or case ID returned no results
1539-5	Invalid request {message}
1539-6	Error saving case
1539-13	Case ID references a case that is currently locked
1539-14	Invalid request message
1539-15	This case is already resolved with status: {status}
1539-16	This case has been submitted for processing and this action can no longer be performed.

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

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

document

string

required

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

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Status codes

default