POST
/api/v1/verification/async/{channel_code}/

Submit a verification request for background processing.

Flow:

  1. Submit verification request
  2. Receive verification_id immediately
  3. Check status using GET /api/v1/verification/async/status/{verification_id}/
  4. Receive webhook notification when complete (if webhook_url configured)

Benefits:

  • No waiting for gateway response
  • Can handle slow gateway responses
  • Higher throughput
  • Automatic retries on failure

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Path Parameters

channel_code*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for async verification requests.

Response Body

application/json

curl -X POST "https://example.com/api/v1/verification/async/string/" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "status": true,    "message": "string",    "data": {      "verification_id": "5bcbf7ac-c998-46ce-aa6e-a0c1a3f1f5bd",      "status": "pending",      "channel_code": "string",      "created_at": "2019-08-24T14:15:22Z",      "estimated_completion": "string"    }  },  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel