Skip to main content

​
API Reference

The Proxy API enables you to programmatically manage customers, agents, cards, and transactions.

​
Base URL

https://api.useproxy.ai/v1

​
Request Format

All requests use JSON bodies and require the Content-Type: application/json header. 
curl -X POST https://api.useproxy.ai/v1/customers \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"type": "consumer", "email": "alice@example.com"}'

​
Response Format

Responses are JSON with consistent structure: 
{
  "id": "cust_xxx",
  "type": "consumer",
  "email": "alice@example.com",
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Errors

Errors return appropriate HTTP status codes with details: 
{
  "error": {
    "code": "invalid_request",
    "message": "Email is required"
  }
}
StatusDescription
400Bad request - invalid parameters
401Unauthorized - invalid API key
404Not found - resource doesn’t exist
429Rate limited - too many requests
500Server error

​
Idempotency

For POST requests, include an Idempotency-Key header to ensure operations are only performed once: 
curl -X POST https://api.useproxy.ai/v1/cards \
  -H "Authorization: Bearer your_api_key" \
  -H "Idempotency-Key: unique-request-id" \
  -d '{"customerId": "cust_xxx"}'
Idempotency keys are cached for 24 hours.

​
Pagination

List endpoints support pagination: 
curl "https://api.useproxy.ai/v1/transactions?limit=10&cursor=cur_xxx" \
  -H "Authorization: Bearer your_api_key"
Response includes pagination info: 
{
  "data": [...],
  "hasMore": true,
  "nextCursor": "cur_yyy"
}

​
Rate Limits

TierRequests/minute
Standard100
Pro1000
EnterpriseCustom

​
Next Steps

Authentication

Set up API authentication

Quickstart

Make your first API call