Submerchant Document Upload

Important
This endpoint is only for submerchants with an Operation Country: Mexico 🇲🇽 (MX) to fulfill the specific MX Documentation task flow.
This endpoint allows PSPs to upload a document for a submerchant for a specific onboarding task flow. The processing is asynchronous and conditioned on the operating country.

Validation and Document Submission

Upon receiving the request, the system performs an initial validation to ensure that the document and operational context are valid. This check verifies:

The submerchant ID exists.

The Operation Country is MX.

The file type is PDF and the size is within the 5 MB limit.

Only documents that pass these preliminary checks will be submitted for further processing in the onboarding flow. Documents that fail must be corrected and resubmitted.

Request Body (JSON)

The request must include the submerchant ID, the document's type and file content, and optionally, a webhook URL for status notification.

Response Handling

If the submission was successful, the system returns a simple success confirmation, indicating that the document has been accepted for processing.

true: The document passed validation and has been submitted for processing.

false: The document or request failed to meet the required format or operational context (e.g., wrong country, invalid file size).

curl --location 'https://api-uat.kushkipagos.com/onboarding/v1/submerchants/files' \ --header 'X-Api-Key;' \ --header 'Content-Type: application/json' \ --data '{ "submerchantId": "1882e596-4213-4cab-88c9-9621dd4e2ba4", "webhookUrl": "https://webhook.site/74a8a000-9400-4f57-b49c-269c3761c7fc", "document": { "name": "PROOF_OF_ADDRESS.pdf", "type": "PROOF_OF_ADDRESS", "file": "" } }'

Important#

Validation and Document Submission#

Request Body (JSON)#

Response Handling#

Request

Responses

Important

Validation and Document Submission

Request Body (JSON)

Response Handling