Submit asynchronous batch

Accepts up to 1,000 CPFs and returns the batch identifier without waiting for processing. The result is read with GET /api/v1/batches/{batch_id}, and the webhook notifies you when it finishes.

Limits: 10 submissions per minute and 50 batches in flight per operator. The first counts submissions, not documents.

Webhook: when the batch closes, we send a POST to the URL registered for your account. That URL — and the key that signs the notification — are set once with the Paag team and apply to all your batches. That is why there is no webhook field in this request body.

Nothing breaks without a registration: the batch is processed and billed normally, and the result stays at GET /api/v1/batches/{batch_id}. What you do not get is the notification.

How to register and how to verify the signature: About KYG webhooks.

Body Params
player_ids
array of strings
required

CPFs in the batch, digits only. Minimum 1, maximum 1,000 after duplicates are removedtotal_requested reflects the deduplicated list, and may be smaller than what you sent.

player_ids*
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json