API Documentation
bronID provides identity verification and screening solutions for individuals as well as complex entity types, including companies, trusts, SMSFs, associations, cooperatives, and government bodies from around the world.
There are three ways bronID clients can use our products:
- Option 1: Manual data entry via the bronID Portal. Enter data manually and receive results through the bronID Portal. This is the least complex option that allows you to start quickly without requiring any integration.
- Option 2: White-label Forms. Configure white-label forms that are automatically generated, then redirect your customers to complete verification through these forms. This medium-complexity option can be used with or without integration, though the form design cannot be significantly customised.
- Option 3: Custom Integration via API. Design your own forms and integrate our API to complete the verification and screening process. This option requires integration within your existing solutions but offers the most flexibility in designing your customer journey.
Based on your preferences and technical capabilities, you may choose to use any one of these options or combine multiple approaches within your solution. This API documentation is intended to guide you through integrating either the white-label form or the API.
Getting started
To get started, you will need to create your test account with bronID. Please note that all test and production accounts must be approved by bronID once we conclude the necessary due diligence on your organisation and you have a signed contract with bronID.
To create your test account:
- Access the dedicated URL for the test environment (https://preview.bronid.com/). This will allow you to perform free tests without affecting live data.
- IMPORTANT: We suggest you use a specific email address for this purpose, e.g.
kyc-test@yourcompany.com
(or similar). Do not use your personal work email address for the main account. - Once you have created your account, use the steps in the following guide to generate your API keys: https://www.bronid.com/article/generate-your-api-keys
- When your integration is ready to go live, you will need to follow the same setup steps but in the production environment.
Guides
Whitelabel Forms API
Learn how to use the whitelabel forms API to generate KYC forms for your customers.