> ## Documentation Index > Fetch the complete documentation index at: https://www.bitnob.dev/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Bitnob API requests authenticate with an `X-Auth-Client` API key header against https://api.bitnob.com. > Always use the sandbox environment for testing. Never put live API keys in sample code. > Money amounts are integers in the smallest unit of the currency (satoshis for BTC, cents for fiat). Never use floats. > Every state-changing request takes a client-supplied `reference` and must be treated as idempotent on retry. > Quotes expire. Re-quote rather than reusing a stale quote id. # Start corporate KYB > Starts KYB for corporate cards, for an existing business customer (customer_id) or a new one. Send the returned completion_link to the business to finish verification. ## OpenAPI ````yaml /api-collections/swagger/bitnob-api-v2.openapi.json post /api/cards/kyc/corporate openapi: 3.1.0 info: description: >- The Bitnob API for businesses: customers, virtual accounts, cards, payouts, crypto addresses and transfers, Lightning, trading and exchange rates. ## Authentication Every request is signed with your API key's client id and secret. **Signed requests (recommended).** Send: - `X-Auth-Client`: your client id - `X-Auth-Timestamp`: the current Unix time in seconds; requests more than 5 minutes off are refused - `X-Auth-Nonce`: a unique random string for this request - `X-Auth-Signature`: hex HMAC-SHA256 of `{client_id}:{timestamp}:{nonce}:{body}` using your secret, where body is the raw request body (empty for GET) **Secret mode.** Send `X-Auth-Client` and `X-Auth-Secret` instead. Simpler, but the secret travels with every request. Live keys work only for an active organisation; sandbox keys work at any time. `ANY /api/whoami` echoes the authenticated client and is the quickest way to check your signing. ## Responses Successful responses are wrapped in an envelope with `success`, `message`, `data` and, on lists, `metadata`. Errors come either as the envelope with `success: false` and an `error` object, or as an RFC 7807 problem with a machine-readable `code`; branch on the code. Every response carries an `X-Correlation-ID` header; errors repeat it as `request_id`. Quote it to support. Every request passes a per-IP rate limit of 500 requests a minute (429 with `Retry-After`). This document is maintained by hand and checked against the route table on every build: every /api route is listed here. title: Bitnob API version: 1.0.0 servers: - description: Production url: https://api.bitnob.com security: - BitnobClientId: [] BitnobClientSecret: [] tags: - description: Check that your requests are signed correctly. name: Authentication - description: >- The people and businesses you serve. Creating and editing them needs the customers feature. name: Customers - description: >- Naira accounts that receive bank transfers, for your company or for a customer. name: Virtual accounts - description: Crypto deposit addresses, for your company or for a customer. name: Addresses - description: >- Virtual cards: issue, fund, withdraw, freeze, terminate, and the card KYC and corporate onboarding behind them. name: Cards - description: 'Pay out to bank accounts and mobile money: quote, initialize, finalize.' name: Payouts - description: Saved payout recipients. name: Beneficiaries - description: Banks and account lookups for payouts. name: Banks - description: Balance transfers between Bitnob organisations. name: Transfers - description: Crypto withdrawals. name: Withdrawals - description: Lightning invoices and payments. name: Lightning - description: Lightning addresses, LNURL withdraw links and LNURL payments. name: LNURL - description: Blockchain node access. name: Nodes - description: Quotes and orders for buying and selling. name: Trading - description: Rates and conversions. name: Exchange rates - description: Your transaction history. name: Transactions - description: Wallet balances. name: Balances paths: /api/cards/kyc/corporate: post: tags: - Cards summary: Start corporate KYB description: >- Starts KYB for corporate cards, for an existing business customer (customer_id) or a new one. Send the returned completion_link to the business to finish verification. operationId: cardsInitiateCorporateKyc requestBody: content: application/json: examples: existing_business: summary: Existing business customer value: admin: address: city: Lagos country: Nigeria country_code: NG line1: 12 Admiralty Way postal_code: '106104' region: Lagos birth_date: '1985-02-17' country_of_issue: NG email: kwame.mensah@example.com first_name: Kwame is_terms_of_service_accepted: true last_name: Mensah national_id: '00000000000' phone_country_code: '+234' phone_number: '8000000002' company_address: city: Lagos country: Nigeria country_code: NG line1: 4 Creek Road line2: Apapa postal_code: '102272' region: Lagos customer_id: 019a3b5c-4f60-7b2c-8d3e-5f6a7b8c9d71 entity: description: Last-mile delivery across Lagos expected_spend: '25000' industry: '484110' name: Acme Logistics Ltd registration_number: RC0000001 tax_id: TIN-00000001 type: private_limited_company website: https://acme-logistics.example.com redirect_url: https://example.com/cards/kyb/done ubos: - address: city: Lagos country: Nigeria country_code: NG line1: 12 Admiralty Way postal_code: '106104' region: Lagos birth_date: '1985-02-17' country_of_issue: NG email: kwame.mensah@example.com first_name: Kwame is_terms_of_service_accepted: true last_name: Mensah national_id: '00000000000' ownership_percentage: 60 phone_country_code: '+234' phone_number: '8000000002' inline_business: summary: New business customer created inline value: admin: address: city: Lagos country: Nigeria country_code: NG line1: 12 Admiralty Way postal_code: '106104' region: Lagos birth_date: '1985-02-17' country_of_issue: NG email: kwame.mensah@example.com first_name: Kwame is_terms_of_service_accepted: true last_name: Mensah national_id: '00000000000' phone_country_code: '+234' phone_number: '8000000002' company_address: city: Lagos country: Nigeria country_code: NG line1: 4 Creek Road line2: Apapa postal_code: '102272' region: Lagos customer: business_name: Acme Logistics Ltd city: Lagos country: NGA customer_type: business date_of_birth: '1985-02-17' email: cards@acme-logistics.example.com first_name: Kwame id_number: RC0000001 last_name: Mensah line1: 4 Creek Road postal_code: '102272' registration_number: RC0000001 state: Lagos entity: description: Last-mile delivery across Lagos expected_spend: '25000' industry: '484110' name: Acme Logistics Ltd registration_number: RC0000001 tax_id: TIN-00000001 type: private_limited_company website: https://acme-logistics.example.com ubos: - address: city: Lagos country: Nigeria country_code: NG line1: 12 Admiralty Way postal_code: '106104' region: Lagos birth_date: '1985-02-17' country_of_issue: NG email: kwame.mensah@example.com first_name: Kwame is_terms_of_service_accepted: true last_name: Mensah national_id: '00000000000' ownership_percentage: 60 phone_country_code: '+234' phone_number: '8000000002' schema: $ref: '#/components/schemas/CardsInitiateCorporateKycRequest' required: true responses: '200': content: application/json: example: data: completion_link: https://kyb.sandbox.example.com/s/sbx_2b8e61f4a9c3 customer_id: 019a3b5c-4f60-7b2c-8d3e-5f6a7b8c9d71 status: pending message: Corporate KYC initiated successfully success: true timestamp: '2026-10-30T09:15:02.481Z' schema: allOf: - $ref: '#/components/schemas/Envelope' - properties: data: $ref: '#/components/schemas/CardsCorporateKycResult' type: object description: OK '400': content: application/json: examples: field_validation: summary: Required blocks are missing value: error: code: BAD_REQUEST details: admin: Admin is required entity: Entity is required message: Validation failed request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c1 success: false timestamp: '2026-10-30T09:15:02.481Z' invalid_body: summary: The body is not valid JSON value: error: code: BAD_REQUEST message: Invalid request body request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c0 success: false timestamp: '2026-10-30T09:15:02.481Z' kyc_fee_insufficient_balance: summary: The company cannot pay the KYB fee value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c6 detail: Insufficient company balance for the card KYC fee extensions: company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 error_code: KYC_FEE_INSUFFICIENT_BALANCE request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c6 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR selector: summary: Both customer_id and customer were sent value: error: code: BAD_REQUEST details: customer: Provide either customer_id or customer, not both message: Validation failed request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c2 success: false timestamp: '2026-10-30T09:15:02.481Z' tax_id_required: summary: entity.tax_id or registration details are missing value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c3 detail: entity name, registration_number and tax_id are required request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c3 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR terms_not_accepted: summary: The admin has not accepted the terms value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c5 detail: terms of service must be accepted request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c5 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR ubo_required: summary: No UBO listed value: code: VALIDATION_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c4 detail: at least one UBO is required request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c4 status: 400 timestamp: '2026-10-30T09:15:02Z' title: Validation Error type: https://api.bitnob.com/errors/VALIDATION_ERROR schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Validation failed (envelope), or a check in the KYC service failed (Problem, VALIDATION_ERROR), including a company balance that cannot cover the KYB fee (extension error_code KYC_FEE_INSUFFICIENT_BALANCE). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '401': $ref: '#/components/responses/Unauthorized' '403': content: application/json: examples: customer_cards_off: summary: >- The holder is a customer of the company and customer cards are off value: code: FEATURE_NOT_ENABLED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0095 detail: >- The cards for customers feature is currently not available. extensions: company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 feature_key: customer_cards request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0095 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Feature Not Enabled type: https://api.bitnob.com/errors/FEATURE_NOT_ENABLED customers_off: summary: The customers product is off for the company value: code: FEATURE_NOT_ENABLED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0096 detail: The customers feature is currently not available. extensions: company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 feature_key: customers request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0096 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Feature Not Enabled type: https://api.bitnob.com/errors/FEATURE_NOT_ENABLED ip_not_whitelisted: $ref: '#/components/examples/IPNotWhitelisted' org_not_active: $ref: '#/components/examples/OrgNotActive' org_not_active_live: $ref: '#/components/examples/OrgNotActiveLive' virtual_cards_off: summary: The company does not have virtual cards value: code: FEATURE_NOT_ENABLED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0091 detail: The virtual cards feature is currently not available. extensions: company_id: 019a3b5c-1a2b-7c3d-8e4f-5a6b7c8d9e01 feature_key: virtual_cards request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f0091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Feature Not Enabled type: https://api.bitnob.com/errors/FEATURE_NOT_ENABLED schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- The org is not active (ORG_NOT_ACTIVE), the company does not have virtual cards (FEATURE_NOT_ENABLED), or the customers or customer_cards feature is off (FEATURE_NOT_ENABLED). Business applications on this surface always count as serving a customer. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '404': content: application/json: examples: customer_not_found: summary: >- No business customer with this id belongs to your organisation value: code: NOT_FOUND correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c7 detail: >- customer with ID '019a3b5c-4f60-7b2c-8d3e-5f6a7b8c9d71' was not found extensions: id: 019a3b5c-4f60-7b2c-8d3e-5f6a7b8c9d71 resource: customer request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c7 status: 404 timestamp: '2026-10-30T09:15:02Z' title: Resource Not Found type: https://api.bitnob.com/errors/NOT_FOUND schema: $ref: '#/components/schemas/Problem' description: customer_id names no customer of your organisation. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '408': $ref: '#/components/responses/RequestTimeout' '409': $ref: '#/components/responses/Conflict' '422': content: application/json: examples: program_disabled: summary: collateral_business is not enabled for the company value: code: CARD_STATE_CONFLICT correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c8 detail: >- card program "collateral_business" is not enabled for this company request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f00c8 status: 422 timestamp: '2026-10-30T09:15:02Z' title: Card Program Disabled type: https://api.bitnob.com/errors/CARD_STATE_CONFLICT schema: $ref: '#/components/schemas/Problem' description: >- collateral_business is not enabled for this company (CARD_STATE_CONFLICT). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/ServiceUnavailable' components: schemas: CardsInitiateCorporateKycRequest: description: Exactly one of customer_id or customer is required. properties: admin: $ref: '#/components/schemas/CardsCorporatePerson' company_address: $ref: '#/components/schemas/CardsCorporateAddress' customer: $ref: '#/components/schemas/CardsKycCustomerInput' customer_id: description: Existing business customer. Provide this or customer. format: uuid type: string entity: $ref: '#/components/schemas/CardsCorporateEntity' redirect_url: description: >- Where the hosted KYB page returns the user; checked against an allowlist. maxLength: 2048 type: string representatives: items: $ref: '#/components/schemas/CardsCorporatePerson' type: array description: People who represent the business. ubos: description: Ultimate beneficial owners. items: $ref: '#/components/schemas/CardsCorporatePerson' minItems: 1 type: array required: - entity - company_address - admin type: object Envelope: description: >- Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead. properties: data: description: >- The payload; its shape is given per operation. Omitted when there is none. error: $ref: '#/components/schemas/ErrorInfo' message: description: Human-readable summary; omitted when empty. type: string metadata: $ref: '#/components/schemas/Pagination' request_id: description: >- Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support. type: string success: description: true on success type: boolean timestamp: description: When the response was written. format: date-time type: string required: - success - timestamp type: object CardsCorporateKycResult: properties: completion_link: description: Bearer link to the hosted KYB page; omitted when empty. type: string customer_id: format: uuid type: string status: type: string type: object ErrorEnvelope: allOf: - $ref: '#/components/schemas/Envelope' - properties: success: const: false required: - error type: object description: >- The envelope as an error: success is false, error is set, data is absent. Problem: description: >- RFC 7807 problem. Returned when authentication fails and for errors raised by the services behind a handler (validation, domain refusals such as FEATURE_NOT_ENABLED or PRECONDITION_FAILED, partner outages); branch on code. properties: code: description: >- Machine-readable; branch on this, not on the status or the wording. For example VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_NOT_ENABLED, PERSONAL_WORKSPACE_CUSTOMERS, TIER_PRODUCT_LOCKED, NOT_FOUND, DUPLICATE_KEY_ERROR, ALREADY_EXISTS, PRECONDITION_FAILED, INSUFFICIENT_FUNDS, TIER_LIMIT_REACHED, RATE_LIMIT_EXCEEDED, TIMEOUT, SERVICE_UNAVAILABLE, LIMITS_UNAVAILABLE, PLATFORM_PAUSED, INTERNAL_ERROR. type: string correlation_id: description: >- The request's correlation id, the same value as the X-Correlation-ID response header. type: string detail: description: >- What went wrong for this request, safe to show; internal and partner failures carry a generic sentence. type: string extensions: additionalProperties: true description: >- Code-specific facts, for example feature_key (FEATURE_NOT_ENABLED), field or field_violations (VALIDATION_ERROR), rail, window, limit, used, requested and remaining (TIER_LIMIT_REACHED), scope (PLATFORM_PAUSED). type: object instance: type: string request_id: description: Equal to correlation_id. type: string status: description: The HTTP status, repeated. type: integer timestamp: format: date-time type: string title: description: >- Short summary of the code, for example Validation Error or Feature Not Enabled. type: string type: description: https://api.bitnob.com/errors/{code} format: uri type: string required: - type - title - status - code - timestamp type: object CardsCorporatePerson: properties: address: $ref: '#/components/schemas/CardsCorporateAddress' birth_date: format: date type: string description: Date of birth, YYYY-MM-DD. country_of_issue: maxLength: 100 type: string description: Country that issued the identity number. email: format: email maxLength: 254 type: string description: Email address. first_name: maxLength: 100 type: string description: First name. is_terms_of_service_accepted: description: >- Read for the admin, where it must be true ("terms of service must be accepted"), and for a cardholder added with POST .../cardholders, where it must be true too. Ignored on representatives and UBOs. type: boolean last_name: maxLength: 100 type: string description: Last name. national_id: maxLength: 100 type: string description: National identity number. ownership_percentage: maximum: 100 minimum: 0 type: number description: Percentage of the business this person owns. phone_country_code: maxLength: 6 type: string description: International dial code, for example +234. phone_number: maxLength: 20 type: string description: Phone number without the dial code. required: - first_name - last_name - birth_date - national_id - country_of_issue - email - address - phone_country_code - phone_number type: object CardsCorporateAddress: properties: city: maxLength: 100 type: string description: City. country: maxLength: 100 type: string description: Country. country_code: description: ISO 3166-1 alpha-2. maxLength: 2 minLength: 2 type: string line1: maxLength: 200 type: string description: Address line 1. line2: maxLength: 200 type: string description: Address line 2. postal_code: maxLength: 20 type: string description: Postal code. region: maxLength: 100 type: string description: State or region. required: - line1 - city - region - postal_code - country - country_code type: object CardsKycCustomerInput: description: Inline customer for KYC. properties: business_name: maxLength: 200 type: string description: Registered business name. city: maxLength: 100 type: string description: City. country: maxLength: 100 type: string description: Country. customer_type: enum: - individual - business type: string description: Type of customer. date_of_birth: format: date type: string description: Date of birth, YYYY-MM-DD. dial_code: maxLength: 6 type: string description: International dial code, for example +234. email: format: email maxLength: 254 type: string description: Email address. first_name: maxLength: 100 type: string description: First name. id_number: maxLength: 100 type: string description: Number on the identity document. id_type: maxLength: 50 type: string description: Type of identity document. last_name: maxLength: 100 type: string description: Last name. line1: maxLength: 200 type: string description: Address line 1. line2: maxLength: 200 type: string description: Address line 2. phone_number: maxLength: 20 type: string description: Phone number without the dial code. postal_code: maxLength: 20 type: string description: Postal code. registration_number: maxLength: 100 type: string description: Company registration number. state: maxLength: 100 type: string description: State. required: - customer_type - first_name - last_name - date_of_birth - id_number - email - line1 - city - state - postal_code - country type: object CardsCorporateEntity: properties: description: maxLength: 500 type: string description: What the business does. expected_spend: maxLength: 50 type: string description: Expected spend on the cards. industry: description: NAICS code from GET /api/cards/kyc/industries. maxLength: 20 type: string name: maxLength: 200 type: string description: Registered name of the business. registration_number: maxLength: 100 type: string description: Company registration number. tax_id: maxLength: 100 type: string description: Tax identification number. type: maxLength: 50 type: string description: Legal form of the business, for example private_limited_company. website: description: URL or N/A. maxLength: 255 type: string required: - name - industry - registration_number - type - expected_spend - tax_id type: object ErrorInfo: properties: code: description: >- Machine-readable, for example BAD_REQUEST, NOT_FOUND, CONFLICT, ORG_NOT_ACTIVE, RATE_LIMIT_EXCEEDED, SERVICE_UNAVAILABLE, INTERNAL_ERROR. type: string details: additionalProperties: true description: >- For field validation, a map of field name to message ("email": "Email must be a valid email address"); for a body that does not decode, the offending field. type: object message: type: string required: - message type: object Pagination: description: >- List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set. properties: has_more: type: boolean limit: type: integer next_cursor: description: Opaque; pass as cursor for the next page. type: string offset: type: integer page: type: integer per_page: type: integer total: type: integer total_pages: type: integer type: object headers: X-Correlation-ID: description: >- Generated for every request (any value the client sends is ignored); quote it to support. Errors repeat it as request_id and correlation_id. example: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 schema: type: string Retry-After: description: Seconds to wait before retrying. example: 1 schema: minimum: 0 type: integer X-RateLimit-Limit: description: Requests allowed per window by the per-IP limiter (500 a minute). example: 500 schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. example: 0 schema: type: integer X-RateLimit-Reset: description: Seconds until the window resets. example: 37 schema: type: integer responses: Unauthorized: content: application/json: examples: unauthorized_auth_failed: $ref: '#/components/examples/UnauthorizedAuthFailed' unauthorized_invalid_secret: $ref: '#/components/examples/UnauthorizedInvalidSecret' unauthorized_invalid_signature: $ref: '#/components/examples/UnauthorizedInvalidSignature' unauthorized_locked_out: $ref: '#/components/examples/UnauthorizedLockedOut' schema: $ref: '#/components/schemas/Problem' description: >- Authentication failed: a signing header is missing or malformed, the timestamp is more than 5 minutes off, the signature or secret is wrong, or the client is locked out after failed checks (UNAUTHORIZED). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' RequestTimeout: content: application/json: examples: request_timeout: $ref: '#/components/examples/RequestTimeout' schema: $ref: '#/components/schemas/Problem' description: >- The request ran past its deadline (TIMEOUT); retry, with the same reference for writes. headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' Conflict: content: application/json: examples: conflict_envelope: $ref: '#/components/examples/ConflictEnvelope' duplicate_key: $ref: '#/components/examples/DuplicateKey' operation_in_progress: $ref: '#/components/examples/OperationInProgress' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Conflicts with existing state: a repeated reference (DUPLICATE_KEY_ERROR), the same operation already in progress (ALREADY_EXISTS, retry shortly), or the resource's state (CONFLICT). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' TooManyRequests: content: application/json: examples: rate_limited: $ref: '#/components/examples/RateLimited' rate_limited_envelope: $ref: '#/components/examples/RateLimitedEnvelope' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Rate limited. The per-IP limiter (500 requests a minute) answers with a Problem and Retry-After; operation-specific throttles answer with the envelope. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' ServerError: content: application/json: examples: internal_error: $ref: '#/components/examples/InternalError' internal_error_envelope: $ref: '#/components/examples/InternalErrorEnvelope' internal_error_unhandled: $ref: '#/components/examples/InternalErrorUnhandled' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Something failed on our side; safe to retry idempotent requests (INTERNAL_ERROR). headers: X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' ServiceUnavailable: content: application/json: examples: auth_service_busy: $ref: '#/components/examples/AuthServiceBusy' auth_service_unavailable: $ref: '#/components/examples/AuthServiceUnavailable' limits_unavailable: $ref: '#/components/examples/LimitsUnavailable' platform_paused: $ref: '#/components/examples/PlatformPaused' partner_unavailable: $ref: '#/components/examples/PartnerUnavailable' service_unavailable_envelope: $ref: '#/components/examples/ServiceUnavailableEnvelope' schema: oneOf: - $ref: '#/components/schemas/ErrorEnvelope' - $ref: '#/components/schemas/Problem' description: >- Temporarily unavailable; retry later. The identity service could not check the credentials (sent with Retry-After), a partner is down (SERVICE_UNAVAILABLE), the limits check could not run (LIMITS_UNAVAILABLE), or a platform control paused money movement (PLATFORM_PAUSED). headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Correlation-ID: $ref: '#/components/headers/X-Correlation-ID' examples: IPNotWhitelisted: summary: The request came from an IP not on the key's allowlist value: code: FORBIDDEN correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: IP address not whitelisted request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 403 timestamp: '2026-10-30T09:15:02Z' title: Forbidden type: https://api.bitnob.com/errors/FORBIDDEN OrgNotActive: description: Live keys only; sandbox requests pass. summary: A money-moving operation from an organisation that is not active value: error: code: ORG_NOT_ACTIVE message: >- Your organisation is not currently active. Please contact your administrator. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' OrgNotActiveLive: description: Sandbox keys are never refused this way. summary: A live key on an organisation that is not active yet value: error: code: ORG_NOT_ACTIVE message: >- Your business isn't active yet, so live isn't available. Use your sandbox keys until it's activated. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' UnauthorizedAuthFailed: description: >- Returned when X-Auth-Client, X-Auth-Timestamp, X-Auth-Nonce or X-Auth-Signature is missing, the nonce is not 8 to 128 characters, the signature is not hex, or the timestamp is more than 5 minutes from the server's clock. The detail does not say which; check each. summary: A signing header is missing or malformed, or the timestamp is stale value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Authentication failed request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedInvalidSecret: summary: 'Secret mode: the client id or secret is wrong' value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Invalid credentials request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedInvalidSignature: description: >- The detail is the identity service's reason when it gives one (an unknown client or a reused nonce reads differently); Invalid signature otherwise. summary: The signature does not match value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Invalid signature request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED UnauthorizedLockedOut: summary: Too many failed credential checks value: code: UNAUTHORIZED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Too many failed credential checks; retry later request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 401 timestamp: '2026-10-30T09:15:02Z' title: Unauthorized type: https://api.bitnob.com/errors/UNAUTHORIZED RequestTimeout: summary: The request ran past its deadline value: code: TIMEOUT correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: The request took too long to complete. Please try again. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 408 timestamp: '2026-10-30T09:15:02Z' title: Request Timeout type: https://api.bitnob.com/errors/TIMEOUT ConflictEnvelope: summary: Conflicts with the resource's current state (answered by the handler) value: error: code: CONFLICT message: customer has no email address on file request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' DuplicateKey: summary: A resource with the same reference or identifier exists value: code: DUPLICATE_KEY_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: A resource with the same identifier already exists. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 409 timestamp: '2026-10-30T09:15:02Z' title: Resource Already Exists type: https://api.bitnob.com/errors/DUPLICATE_KEY_ERROR OperationInProgress: summary: The same operation is already running; retry shortly value: code: ALREADY_EXISTS correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: A freeze operation is already in progress, please try again shortly extensions: operation: freeze request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 409 timestamp: '2026-10-30T09:15:02Z' title: Operation In Progress type: https://api.bitnob.com/errors/ALREADY_EXISTS RateLimited: summary: The per-IP limit (500 requests a minute) is reached value: code: RATE_LIMIT_EXCEEDED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Too many requests. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 429 timestamp: '2026-10-30T09:15:02Z' title: Rate Limit Exceeded type: https://api.bitnob.com/errors/RATE_LIMIT_EXCEEDED RateLimitedEnvelope: summary: An operation-specific throttle (answered by the handler) value: error: code: RATE_LIMIT_EXCEEDED message: >- a verification link was sent to this customer in the last minute; try again shortly request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' InternalError: summary: Something failed on our side value: code: INTERNAL_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: An internal error occurred. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 500 timestamp: '2026-10-30T09:15:02Z' title: Internal Server Error type: https://api.bitnob.com/errors/INTERNAL_ERROR InternalErrorEnvelope: summary: A failure answered by the handler value: error: code: INTERNAL_ERROR message: Failed to list transactions request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' InternalErrorUnhandled: summary: An unexpected failure value: code: INTERNAL_ERROR correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: An internal server error occurred request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 500 timestamp: '2026-10-30T09:15:02Z' title: Internal Server Error type: https://api.bitnob.com/errors/INTERNAL_ERROR AuthServiceBusy: description: 'Sent with Retry-After: 1.' summary: Too many large signed bodies are being checked at once value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Authentication service is busy, retry shortly request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE AuthServiceUnavailable: description: 'Sent with Retry-After: 1. The detail is worded exactly like this today.' summary: The identity service could not be reached to check the credentials value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Service Authentication service unavailable is currently unavailable request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE LimitsUnavailable: summary: The tier limit check could not run value: code: LIMITS_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- We could not verify your account limits right now. Please try again shortly. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Limits Unavailable type: https://api.bitnob.com/errors/LIMITS_UNAVAILABLE PlatformPaused: summary: Money movement is paused by a platform control value: code: PLATFORM_PAUSED correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: >- Money movement is temporarily paused. Nothing is lost — requests can be retried once the pause lifts. extensions: scope: asset:BTC request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Money Movement Paused type: https://api.bitnob.com/errors/PLATFORM_PAUSED PartnerUnavailable: summary: A partner or internal service is unavailable value: code: SERVICE_UNAVAILABLE correlation_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 detail: Service is temporarily unavailable. Please try again later. request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 status: 503 timestamp: '2026-10-30T09:15:02Z' title: Service Unavailable type: https://api.bitnob.com/errors/SERVICE_UNAVAILABLE ServiceUnavailableEnvelope: summary: Unavailable (answered by the handler) value: error: code: SERVICE_UNAVAILABLE message: LNURL payments are temporarily disabled request_id: req_019a3b5c-7d1e-7f20-8a4b-3c5d6e7f8091 success: false timestamp: '2026-10-30T09:15:02.481Z' securitySchemes: BitnobClientId: type: apiKey in: header name: X-Auth-Client description: | Your workspace client id. All calls must include four headers: - `X-Auth-Client` — your workspace client id - `X-Auth-Timestamp` — Unix seconds - `X-Auth-Nonce` — 16-byte random hex - `X-Auth-Signature` — hex(HMAC-SHA256( `{client_id}:{timestamp}:{nonce}:{raw_body}`, client_secret)) The playground computes the timestamp, nonce and signature for you. BitnobClientSecret: type: apiKey in: header name: X-Playground-Client-Secret description: > Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.