API ReferenceReference
Capture up to 100 people
POST
/persons/bulkProcesses each person independently and returns successful, duplicate, and failed results.
Authorization
ApiKey ApiSecret X-API-Key<token>
The API client key shown in Sakhaa.
In: header
X-API-Secret<token>
The one-time API client secret. Keep it in a server-side secret store.
In: header
Header Parameters
Idempotency-Key*string
A stable key for one logical request. Reuse it only when retrying the same request.
Length
1 <= length <= 512Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/persons/bulk" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "persons": [ { "name": "API Batch Test Person", "email": "api-batch-test@example.invalid", "idempotency_key": "docs-batch-person-0001" } ] }'{ "success": true, "statusCode": 0, "timestamp": "2019-08-24T14:15:22Z", "message": "string", "data": { "successful": [ {} ], "duplicates": [ {} ], "failed": [ {} ] }}