Skip to content

API Overview

RapidID API

RapidID aggregates leading customer verification technologies for flexible & seamless integration with your on-boarding & risk analysis monitoring. Mix & match the products you need for your business, in an all-in-one integrated API.

The RapidID documentation and API change over time, we will attempt to provide you with as much notice as possible about future breaking changes when they occur.

Note: The RapidID API is a server-to-server service, which blocks incoming connections from browsers for security reasons. Please only access our api from a hosted server or use Postman to test.

For more information about RapidID Sandbox APIs, please refer to the User Integrations after logging in. If you are experiencing issues integrating with our API you can contact us by sending an email to support@rapidid.com.

Authentication

To send an authenticated request to the RapidID API you must provide your API token in the Token header within each request.

For example:
Token f65gsdfg4dfs4gsd8f75gs6f7dg5s6fg

Your API token can be found by logging in to your RapiID account under the api page, there will be two tokens there, live and sandbox. Make sure you use sandbox for testing purposes only and avoid using the live token for testing as you may incur charges.

Remember to keep your keys secure!

Do not share them via unprotected channels or give them to anyone outside of your organisation. Never store them in publicly accessible locations such us browser-executed code, unprotected cloud storage, public repositories etc. You should recycle your API keys on a regular basis, this can done by generating new keys in the RapidID dashboard and updating any services that use them.

Using This Collection

To start using the API, configure your request setup with the required authentication and environment values. These values are used across all endpoints, allowing you to switch easily between sandbox and live environments.

Once configured, include the following variables in your request configuration:

  • access_token – this is your authentication token (retrieving your token is explained in the Authentication section)
  • environment – this must be either live or sandbox and should match the correct acces_token

Each endpoint includes example requests and responses to help you validate your integration and understand expected behaviours, including error scenarios where applicable.

Error Responses

All endpoints will have custom error responses for handling incorrect request data, there will be an example for each endpoint in the documentation named "Error Response" to show the structure of the response object.

Glossary

  • AML: Anti-Money Laundering

  • OFAC: Office of Foreign Assets Control

  • PEP: Politically Exposed Persons

  • ASIC: Australian Securities and Investments Commission

  • DVS: Document Verification Service

  • KYC: Know Your Customer

  • EIDV: Electronic Identity Verification

  • CVS: China Verification Service

  • CNBC: China Banking Card

  • NVS: New Zealand Verification Service

  • DIABC: Department of Internal Affairs Birth Certificate

  • DIACT: Department of Internal Affairs Citizenship Certificate

  • NZTADL: New Zealand Transport Agency Drivers Licence

  • DIAPS: Department of Internal Affairs Passport Document

  • NZTAMVR: Department of Internal Affairs Motor Vehicle Registration

  • IRN: Individual Reference Number

  • CTF: Counter-Terrorism Financing