Developers

Search for documents

Dev

TC Documents

Terms & Conditions document operations

All endpoints require either a JWT Bearer token in the Authorization header or an API key in the X-API-KEY header.

Base URL: https://onboarding.valpay.com.

GET `/v1/tc-documents`

List available TC documents

Returns available Terms & Conditions documents. Use the country parameter to filter documents by region and get only filenames.

Region mapping:

Region	Countries
US	US
CA	CA
AU	AU, NZ, HK
UK	UK
EU	AT, BE, CH, DE, FR, IE, IT, LU, NL, PT

Use the returned filename as the tcDocument value when creating a merchant.

Parameters

Name	In	Type	Required	Description
`country`	query	`string (enum)`	No	Filter TC documents by country. Returns only filenames matching the country's TC region. One of: `US`, `CA`, `GB`, `AU`, `AT`, `CH`, `DE`, `PT`, `IT`, `BE`, `NL`, `FR`, `LU`, `NZ`, `IE`, `HK`

Responses

Status	Description
`200`	List of available TC documents
`401`	Authentication failed — missing or invalid credentials

Response schema (2xx)

Field	Type	Required
`success`	`boolean`	No
`data`	`array<object>`	No
`message`	`string`	No

Examples

GET `/v1/tc-documents`

curl "https://onboarding.valpay.com/v1/tc-documents?country=CA" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

curl "https://onboarding.valpay.com/v1/tc-documents?country=CA" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

curl "https://onboarding.valpay.com/v1/tc-documents?country=CA" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response 200 (illustrative):

{
  "success": true,
  "data": [
    { "filename": "ValPay-T&C-CA-English-2025.pdf", "region": "CA" }
  ],
  "message": "TC documents retrieved successfully"
}

{
  "success": true,
  "data": [
    { "filename": "ValPay-T&C-CA-English-2025.pdf", "region": "CA" }
  ],
  "message": "TC documents retrieved successfully"
}

{
  "success": true,
  "data": [
    { "filename": "ValPay-T&C-CA-English-2025.pdf", "region": "CA" }
  ],
  "message": "TC documents retrieved successfully"
}