Skip to main content

Base URL

https://api.txcloud.io/v1
For testing, use the sandbox environment:
https://sandbox.api.txcloud.io/v1

Authentication

All API requests require authentication via Bearer token:
curl https://api.txcloud.io/v1/identity/verify \
  -H "Authorization: Bearer txc_live_your_api_key"

Authentication Guide

Learn more about API authentication

APIs

Request Format

All POST/PUT requests use JSON:
curl -X POST https://api.txcloud.io/v1/identity/verify \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document_front": "...", "country": "MA"}'

Response Format

All responses are JSON:
{
  "id": "ver_a1b2c3d4",
  "object": "identity.verification",
  "created_at": "2025-01-15T10:30:00Z",
  "status": "verified",
  ...
}

Pagination

List endpoints use cursor-based pagination:
GET /v1/identity/verifications?limit=20&starting_after=ver_abc123
{
  "object": "list",
  "data": [...],
  "has_more": true,
  "next_cursor": "ver_xyz789"
}

Rate Limits

PlanRequests/Minute
Free60
Starter300
Growth1,000
EnterpriseCustom

Errors

All errors follow a consistent format:
{
  "error": {
    "code": "invalid_request",
    "message": "Document image is required",
    "type": "validation_error",
    "request_id": "req_a1b2c3d4"
  }
}

Error Codes Reference

View all error codes