INSTRUCTIONS TO USE
How to use this API
Start here, then use the detailed request and response reference below.
- 01Get your API key
Use a workspace API key in the Bearer header.
- 02Submit account details
Send a unique transID, country, account owner, and IBAN or bank details.
- 03Inspect the result
Read the returned verification fields and match details.
AUTHENTICATION
Use the same AI7 credential
Send your personal AI7 API key as an HTTP Bearer token. The same credential works across every API enabled for your account.
Authorization: Bearer YOUR_AI7_API_KEY
REQUEST
Submit an account verification
Send application/json. Field names and values are passed through exactly as documented.
transIDstring · requiredYour unique transaction ID. The live tester generates a fresh value for every run.
docTypenumber · server enforcedAlways 610. AI7 enforces this value before forwarding the request.
countrystring · requiredISO country code, such as AE.
sourcestring · optionalRequest source; normally API.
firstNamestring · optionalAccount owner's first name.
lastNamestring · optionalAccount owner's last name.
completeNamestring · required for businessComplete account-owner name. The live tester fills it from first and last name when left blank.
requestCategorystring · requiredRequest category. Use business for document type 610.
bankCodestring · optionalBank or branch code.
bankAccountNumberstring · optionalBank account number.
bicstring · optionalBank Identifier Code.
ibanstring · optionalInternational Bank Account Number.
idstring · optionalIdentity number.
idTypestring · optionalIdentity document type.
RESPONSES
Exact decrypted response contract
The wrapper returns the verification HTTP status and decrypted JSON response without renaming any response fields.
FieldTypeDescription
msgstringResult message, such as success or no record found.
statusnumberResult status code in the JSON body.
dataobjectSuccessful result container.
data.results.bankstringBank match result.
data.results.resultstringOverall account match description.
data.results.countrystringReturned country.
data.results.bankCodestringBank-code match result.
data.results.completeNamestringAccount-owner name match result.
data.results.bankAccountNumberstringAccount-number match result.
trans_idstringTransaction identifier returned on success.
ts_transaction_idstringVerification transaction identifier returned on success.
transIDstringTransaction identifier used by no-record and error variants.
tsTransIdstringVerification transaction identifier used by no-record and error variants.
Status codes
200Verification completed, including match or no-record results
400Invalid JSON or request parameters
401Missing or invalid AI7 API key
500Verification service failed
LIVE TESTER
Run a request
This tester submits to the KYCProbe API engine. Direct integrations use api.ai7uae.com. The credential stays in this page's memory and is not stored.
API RESPONSEReady
{
"message": "Your JSON response will appear here."
}