API reference
Every V1 endpoint at a glance.
This documentation covers API V1.
On this page
Data API
Authenticated with an API key: Authorization: Bearer sk_...
| Method | Path | Description |
|---|---|---|
| GET | /v1/iban/validate?iban= | Validate an IBAN. |
| GET | /v1/iban/{iban} | Validate an IBAN and resolve the bank (SWIFT/BIC, local-first). |
| GET | /v1/swift/{code} | Look up a SWIFT/BIC code. |
| GET | /v1/routing/{number} | Look up a US routing number. |
| GET | /v1/sort-code/{code} | Look up a UK sort code. |
| GET | /v1/bsb/{code} | Look up an Australian BSB. |
| GET | /v1/ifsc/{code} | Look up an Indian IFSC. |
| GET | /v1/cnaps/{code} | Look up a China CNAPS code. |
| GET | /v1/bin/{bin} | Look up a card BIN/IIN (brand, type and issuer). |
| GET | /v1/banks | List financial institutions. |
| GET | /v1/banks/{id} | Get one institution. |
| GET | /v1/banks/search?q= | Search institutions by name. |
| GET | /v1/banks/by-slug/{slug} | Get one institution by its URL slug. |
| GET | /v1/banks/{id}/branches | List branches of an institution. |
| GET | /v1/countries | List countries. |
| GET | /v1/countries/{code} | Get one country. |
| GET | /v1/countries/{code}/iban-format | Get the IBAN format for a country. |
| GET | /v1/lookup?q= | Universal identifier lookup. |
Developer portal
Account, organization, API key, billing and usage endpoints. Authenticated with a JWT access token from POST /v1/auth/login: Authorization: Bearer <access_token>.
| Method | Path | Description |
|---|---|---|
| POST | /v1/auth/register | Create an account and its personal organization. |
| POST | /v1/auth/login | Exchange email and password for access and refresh tokens. |
| POST | /v1/auth/refresh | Rotate a refresh token; the presented token is revoked. |
| POST | /v1/auth/logout | Revoke the presented refresh token. |
| GET | /v1/auth/me | Current account profile and organizations. |
| POST | /v1/auth/password-reset/request | Request a single-use password reset token. |
| POST | /v1/auth/password-reset/confirm | Consume a reset token and set a new password. |
| GET | /v1/organizations | Organizations of the current account. |
| GET | /v1/organizations/{id} | Get one organization. |
| GET | /v1/organizations/{id}/members | List members of an organization. |
| POST | /v1/organizations/{id}/members | Add a member by email (OWNER or ADMIN). |
| PATCH | /v1/organizations/{id}/members/{memberId} | Change a member role (OWNER only). |
| DELETE | /v1/organizations/{id}/members/{memberId} | Remove a member (OWNER or ADMIN). |
| POST | /v1/api-keys | Create an API key; the plaintext key is returned once. |
| GET | /v1/api-keys | List API keys of the organization. |
| DELETE | /v1/api-keys/{id} | Revoke an API key (idempotent). |
| POST | /v1/api-keys/{id}/rotate | Revoke and replace an API key. |
| GET | /v1/usage | Usage summary with quota for the current month. |
| GET | /v1/usage/endpoints | Per-endpoint request counts and error rates. |
| GET | /v1/usage/daily | Daily request counts for charts. |
| GET | /v1/usage/keys | Per-API-key request totals. |
| GET | /v1/billing | Subscription, plan and entitlement summary. |
| POST | /v1/billing/checkout | Start a subscription checkout for a plan (OWNER only). |
| POST | /v1/billing/subscriptions/{subscriptionId}/confirm | Confirm a checkout after approval (OWNER only). |
| POST | /v1/billing/subscriptions/{subscriptionId}/revise | Upgrade or downgrade a subscription (OWNER only). |
| POST | /v1/billing/subscriptions/{subscriptionId}/cancel | Cancel a subscription (OWNER only). |
| GET | /v1/billing/invoices?subscription_id= | Invoices of a subscription. |
Base URL
http
Production: https://api.ecommica.com/v1
Development: http://localhost:8080/v1