APIs

Data APIs

8 APIs in 4 groups, sharing one auth scheme, response format and error format. Prices are agreed with your plan and shown in the Workspace once your account is open.

Machine-readable listWith params, no key required

GET https://dato.aidb.com.cn/api/v1/ops?all=1

01company

Company records

Search Chinese companies by name keyword, or fetch registry details by unified social credit code, full name or registration number.

SourceCompany registration records published by regulators

Read the docs

API	Method	Data freshness	Required params
Company search `company.search` By name keyword, registration number or credit code; 20 per page	`GET / POST/api/v1/company/search`	Within 7 days	`keyword`
Company details `company.query` Registry details by credit code, full name or registration number	`GET / POST/api/v1/company/query`	Within 7 days	`creditNo \| name \| regNo`

02verify

Identity verification

Check whether a name matches an ID number, mobile number or bank card. Returns only match, mismatch or not found.

SourceVerification channels, through partner data providers

Read the docs

API	Method	Data freshness	Required params
ID card, 2 factorsEnabled on request `idcard.verify` Name and ID number match	`POST/api/v1/idcard/verify`	Real time	`nameidNo`
Mobile, 3 factorsEnabled on request `mobile.verify` Mobile, name and ID number belong to one person; returns the carrier	`POST/api/v1/mobile/verify`	Real time	`mobilenameidNo`
Bank card, 3 or 4 factorsEnabled on request `bankcard.verify` Card, name and ID number; add mobile for 4-factor checks	`POST/api/v1/bankcard/verify`	Real time	`cardNonameidNo`

03bank

Bank branch codes

Look up bank branches by name or code. Returns the 12-digit CNAPS code, full branch name, address and phone.

SourcePBOC payment system bank codes

Read the docs

API	Method	Data freshness	Required params
Branch code lookup `bank.search` By branch name or code; filter by bank, province, city	`GET / POST/api/v1/bank/search`	Within 30 days	`keyword`

04fx

Exchange rates

Bank of China RMB rates for 23 currencies: middle rate plus spot and cash buy/sell. Amounts are returned as strings, so no precision is lost.

SourceBank of China RMB rates

Read the docs

API	Method	Data freshness	Required params
Exchange rate `fx.rate` Middle or buy/sell rate between two currencies	`GET / POST/api/v1/fx/rate`	Within 1 hour	`fromto`
Currency conversion `fx.convert` Convert an amount at the chosen rate type	`GET / POST/api/v1/fx/convert`	Within 1 hour	`fromtoamount`

Conventions

What every API shares

Path: /api/v1/{group}/{name}, e.g. /api/v1/fx/rate
Auth: Authorization: Bearer <API Key>; X-Api-Key is also accepted
Request: GET with a query string or POST with a JSON body; verification APIs are POST only
Success: {data, meta}; meta has fetchedAt, credits, deduplicated and requestId
Errors: RFC 9457 problem details (application/problem+json); branch on code, not on HTTP status
Freshness: Fixed per API; meta.fetchedAt is the exact time. force=1 refetches and is charged
Versioning: v1 only adds fields. Breaking changes ship as /api/v2/ with an announced migration period

API reference and test calls

The reference page renders the live OpenAPI spec: params, fields and error codes match production. Sign in to try calls from the page.

Open the API reference

Get an account and your first key

FIM opens accounts. Tell us about your company and use case, and we will set up a tenant and issue credits.

Get access