Upload Documents

PUT

gcc

partner

merchant

onboard

{onboardingId}

docs

Upload Documents

curl --request PUT \
  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs \
  --header 'Content-Type: application/json' \
  --header 'x-gl-auth: <api-key>' \
  --header 'x-gl-digest: <api-key>' \
  --data '
{
  "merchantDocType": "COI_DOCUMENT",
  "url": "https://your-storage.com/documents/coi.pdf",
  "fileName": "certificate_of_incorporation.pdf"
}
'

import requests

url = "https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs"

payload = {
    "merchantDocType": "COI_DOCUMENT",
    "url": "https://your-storage.com/documents/coi.pdf",
    "fileName": "certificate_of_incorporation.pdf"
}
headers = {
    "x-gl-auth": "<api-key>",
    "x-gl-digest": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.put("https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs")
  .header("x-gl-auth", "<api-key>")
  .header("x-gl-digest", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantDocType\": \"COI_DOCUMENT\",\n  \"url\": \"https://your-storage.com/documents/coi.pdf\",\n  \"fileName\": \"certificate_of_incorporation.pdf\"\n}")
  .asString();

const url = 'https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs';
const options = {
  method: 'PUT',
  headers: {
    'x-gl-auth': '<api-key>',
    'x-gl-digest': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    merchantDocType: 'COI_DOCUMENT',
    url: 'https://your-storage.com/documents/coi.pdf',
    fileName: 'certificate_of_incorporation.pdf'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "businessDetails": {
        "entityType": "<string>",
        "gstNumber": "<string>",
        "natureOfBusiness": "<string>",
        "registeredName": "<string>",
        "tradeName": "<string>",
        "iec": "<string>",
        "businessMonthlySize": "<string>",
        "websiteUrl": "<string>",
        "purposeCode": "<string>",
        "businessRegisteredAddress": {
          "streetAddress1": "<string>",
          "streetAddress2": "<string>",
          "zipcode": "<string>",
          "stateCode": "MH",
          "city": "<string>",
          "state": "Maharashtra"
        },
        "businessOperatingAddress": {
          "streetAddress1": "<string>",
          "streetAddress2": "<string>",
          "zipcode": "<string>",
          "stateCode": "MH",
          "city": "<string>",
          "state": "Maharashtra"
        }
      },
      "directorDetails": [
        {
          "designation": "<string>",
          "name": "<string>",
          "pan": "<string>"
        }
      ],
      "beneficialOwnerDetails": [
        {
          "designation": "<string>",
          "name": "<string>",
          "pan": "<string>",
          "percentageOwnership": 123
        }
      ],
      "authorisedSignatoryDetails": {
        "authSignatoryName": "<string>",
        "authSignatoryPan": "<string>",
        "contact": {
          "phone": "<string>",
          "email": "<string>"
        }
      },
      "settlementDetails": {
        "bankAccountNumber": "<string>",
        "bankIfscCode": "<string>",
        "accountHolderName": "<string>"
      }
    },
    "merchantOnboardingCheckListStatus": {
      "documentsToBeUploaded": [
        "<string>"
      ]
    }
  }
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": null,
  "errorDetails": [
    {
      "fieldName": "paymentData.totalAmount",
      "message": "This field is required"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "UNAUTHORIZED",
  "data": {},
  "errors": null,
  "errorDetails": [
    {
      "fieldName": "authorization",
      "message": "Invalid x-gl-token-external"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": {},
  "errorDetails": [
    {
      "field": "panNumber",
      "message": "Required field is missing"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": {},
  "errorDetails": [
    {
      "field": "panNumber",
      "message": "Required field is missing"
    }
  ]
}

When to Use

Uploads a single compliance document for the merchant. Call this endpoint once per document type required.

Documents cannot be uploaded or updated after the merchant’s verification step is complete.

Check documentsToBeUploaded in the Get Onboarding Status response to see which documents are pending. After each upload, poll GET /status to confirm the list has updated. See the full Dynamic document pendencies matrix for trigger conditions and merchantDocType mappings.

Error Scenarios

Scenario	HTTP Code
Required fields validation error	`400`
Update attempted after verification step is complete	`400`
`onboardingId` does not exist	`404`
`onboardingId` does not belong to this partner	`403`

Authorizations

x-gl-auth

string

header

required

Static API Key generated from the PayGlocal Partner Dashboard.

x-gl-digest

string

header

required

Per-request HmacSHA256 signature, Base64-encoded, using your API Secret as the HMAC key.

For GET requests: sign the request URI path (e.g. /gcc/v2/partner/merchant/onboard/business-category), including query string if present.
For POST/PUT requests: sign the exact raw request body.

Path Parameters

onboardingId

string

required

Body

application/json

merchantDocType

enum<string>

required

Document type identifier.

Available options:

IEC,

LOB_DOCUMENT,

MOA_DOCUMENT,

AOA_DOCUMENT,

COI_DOCUMENT,

OPERATING_ADDRESS_PROOF,

LLP_AGREEMENT,

PARTNERSHIP_DEED,

UDYAM,

PAN,

BUSINESS,

ADDRESS,

ACCOUNT,

AUTH_SIGNATORY,

BO,

DIRECTOR,

MOA,

AOA,

COI,

BR,

LLP

Example:

"COI_DOCUMENT"

url

string<uri>

required

Publicly accessible URL of the document file. Must be reachable by PayGlocal servers at submission time.

Example:

"https://your-storage.com/documents/coi.pdf"

fileName

string

Optional human-readable file name. Used only for display in the PayGlocal dashboard.

Example:

"certificate_of_incorporation.pdf"

Response

Document uploaded successfully.

gid

string

PayGlocal global transaction ID.

Example:

"gl_9c2645ed09edb22e"

timestamp

string

Response timestamp (DD/MM/YYYY HH:MM:SS).

Example:

"10/01/2026 15:00:00"

reasonCode

string

Empty string on success.

Example:

""

data

object

Show child attributes

Update Authorised Signatory

Configure Products and Fees

Upload Documents

curl --request PUT \
  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs \
  --header 'Content-Type: application/json' \
  --header 'x-gl-auth: <api-key>' \
  --header 'x-gl-digest: <api-key>' \
  --data '
{
  "merchantDocType": "COI_DOCUMENT",
  "url": "https://your-storage.com/documents/coi.pdf",
  "fileName": "certificate_of_incorporation.pdf"
}
'

import requests

url = "https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs"

payload = {
    "merchantDocType": "COI_DOCUMENT",
    "url": "https://your-storage.com/documents/coi.pdf",
    "fileName": "certificate_of_incorporation.pdf"
}
headers = {
    "x-gl-auth": "<api-key>",
    "x-gl-digest": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.put("https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs")
  .header("x-gl-auth", "<api-key>")
  .header("x-gl-digest", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantDocType\": \"COI_DOCUMENT\",\n  \"url\": \"https://your-storage.com/documents/coi.pdf\",\n  \"fileName\": \"certificate_of_incorporation.pdf\"\n}")
  .asString();

const url = 'https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/docs';
const options = {
  method: 'PUT',
  headers: {
    'x-gl-auth': '<api-key>',
    'x-gl-digest': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    merchantDocType: 'COI_DOCUMENT',
    url: 'https://your-storage.com/documents/coi.pdf',
    fileName: 'certificate_of_incorporation.pdf'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "businessDetails": {
        "entityType": "<string>",
        "gstNumber": "<string>",
        "natureOfBusiness": "<string>",
        "registeredName": "<string>",
        "tradeName": "<string>",
        "iec": "<string>",
        "businessMonthlySize": "<string>",
        "websiteUrl": "<string>",
        "purposeCode": "<string>",
        "businessRegisteredAddress": {
          "streetAddress1": "<string>",
          "streetAddress2": "<string>",
          "zipcode": "<string>",
          "stateCode": "MH",
          "city": "<string>",
          "state": "Maharashtra"
        },
        "businessOperatingAddress": {
          "streetAddress1": "<string>",
          "streetAddress2": "<string>",
          "zipcode": "<string>",
          "stateCode": "MH",
          "city": "<string>",
          "state": "Maharashtra"
        }
      },
      "directorDetails": [
        {
          "designation": "<string>",
          "name": "<string>",
          "pan": "<string>"
        }
      ],
      "beneficialOwnerDetails": [
        {
          "designation": "<string>",
          "name": "<string>",
          "pan": "<string>",
          "percentageOwnership": 123
        }
      ],
      "authorisedSignatoryDetails": {
        "authSignatoryName": "<string>",
        "authSignatoryPan": "<string>",
        "contact": {
          "phone": "<string>",
          "email": "<string>"
        }
      },
      "settlementDetails": {
        "bankAccountNumber": "<string>",
        "bankIfscCode": "<string>",
        "accountHolderName": "<string>"
      }
    },
    "merchantOnboardingCheckListStatus": {
      "documentsToBeUploaded": [
        "<string>"
      ]
    }
  }
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": null,
  "errorDetails": [
    {
      "fieldName": "paymentData.totalAmount",
      "message": "This field is required"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "UNAUTHORIZED",
  "data": {},
  "errors": null,
  "errorDetails": [
    {
      "fieldName": "authorization",
      "message": "Invalid x-gl-token-external"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": {},
  "errorDetails": [
    {
      "field": "panNumber",
      "message": "Required field is missing"
    }
  ]
}

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "VALIDATION_ERROR",
  "data": {},
  "errors": {},
  "errorDetails": [
    {
      "field": "panNumber",
      "message": "Required field is missing"
    }
  ]
}

Partner APIs: Merchant Onboarding

Payment APIs

Partner APIs: MCA

When to Use

Error Scenarios

Authorizations

Path Parameters

Body

Response

​When to Use

​Error Scenarios

Authorizations

Path Parameters

Body

Response

When to Use

Error Scenarios