Retrieve a customer

0Gate is the primary public integration path for hosted payment, ramp, and swap experiences. Keep secret-key operations on your server and hand only browser-safe values to the widget.

Read a single customer (identity) record by its 0Bit id. This returns the full CRM-style record you created — contact fields and your metadata — scoped to your account. It is a standard identity read, not a privacy-minimized KYC view.

Endpoint

The {id} path parameter is a customer id returned by POST /v1/customers or GET /v1/customers. A customer that belongs to a different partner returns 404 — cross-tenant access is never 403, so there is no existence leak across accounts.

Use it for

Look up one customer to confirm its current contact fields, metadata, and kyc_status. If you only have your own reference, prefer GET /v1/customers?external_id=… instead of storing the 0Bit id everywhere.

Production rules

• Keep secret keys on your server. This endpoint requires an sk_* key.
• Wrap the path id in your code — the {id} placeholder is a literal customer id at call time.
• A soft-deleted customer reads as 404. Treat a 404 as "gone or never yours", not as a transient error to retry.
• Treat kyc_status as an informational signal only — it is not partner-settable and is unverified at launch.
• Treat examples and placeholder ids as fake data only.

Path parameters

Response

Returns 200 with the customer object.

Customer object

Examples

curl https://gate-api.0bit.app/v1/customers/67a1f3b9e4b0c10001234567 \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "id": "67a1f3b9e4b0c10001234567",
  "object": "customer",
  "partner_id": "ptnr_test_000000000001",
  "mode": "test",
  "livemode": false,
  "external_id": "user_42",
  "email": "jordan@example.com",
  "phone": "+447700900000",
  "first_name": "Jordan",
  "last_name": "Doe",
  "country_code": "GB",
  "kyc_status": "unverified",
  "metadata": { "plan": "pro" },
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

Errors

All errors use the unified envelope and carry an X-Request-Id response header. Branch on code/type/statusCode, not on the free-form message.

{
  "type": "not_found",
  "code": "not_found",
  "message": "Customer 67a1f3b9e4b0c10001234567 not found",
  "request_id": "req_test_000000000123",
  "doc_url": null,
  "statusCode": 404
}

Public boundary

This reference covers partner-scoped endpoint behavior, authentication, idempotency, webhook verification, and support-safe records. Internal operations, administrative routes, and unsupported availability claims are outside the public API contract.

Related pages