Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IDRX Onboarding API

Onboard users and manage their bank accounts.

IDRX Onboarding API is one of 2 APIs that IDRX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://idrx.co.

6 operations 6 paths 3 schemas 1 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://idrx.co/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IDRX Onboarding API declares 1 security scheme for authenticating requests. An API key is passed in the header as idrx-api-key (idrxApiKey). By default, every request must be authenticated.

  • idrxApiKey — API key issued by IDRX. Each request must also carry idrx-api-sig (an HMAC-SHA256 signature) and idrx-api-ts (Unix ms timestamp), plus a custom User-Agent. Sig…

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Onboarding 6

Onboard users and manage their bank accounts.

POST
/api/auth/generate-api-key
Generate an API key
generateApiKey → 201
POST
/api/auth/onboarding
Onboard a new user
onboardUser body → 201400401403
GET
/api/auth/members
Get members
getMembers → 200401
POST
/api/auth/add-bank-account
Add a bank account
addBankAccount body → 201400401
GET
/api/auth/get-bank-accounts
Get bank accounts
getBankAccounts → 200401
DELETE
/api/auth/delete-bank-account/{bankId}
Delete a bank account
deleteBankAccount 1 param → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BankAccount (10 properties), Error (3 properties), BankAccountEnvelope (3 properties). Each schema is shown below with its type and property counts.

BankAccount
object
10 properties
BankAccountEnvelope
object
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

idrx-onboarding-api-openapi.yml Raw ↑

Other APIs IDRX publishes across the network.

IDRX Transaction API