API Reference
Pre-filling Customer Details
Pass customer context to reduce onboarding friction
When you already have customer information (e.g. from your application form), you can pass it to VerifiMe via the customerContext field in POST /v1/user/invite. VerifiMe will pre-fill the customer's details in the onboarding wizard, reducing data entry and improving completion rates.
What Gets Pre-filled
customerContext Field | Pre-filled Location |
|---|---|
firstName, familyName, middleName, fullName | Name fields in wizard Step 1 |
preferredContactNumber | Phone number in wizard Step 1 |
address | Address fields in wizard Step 1 (resolved via address lookup) |
dateOfBirth | Date of birth in wizard Step 1 |
Behaviour
- Pre-fill is once-consumable: the data is surfaced to the customer on their first visit to the wizard. After the customer submits the full wizard, the pre-fill data is consumed and will not appear again.
- Pre-fill data is surfaced as suggested values - the customer can edit any field before submitting.
- If no
customerContextis provided, the wizard starts with a blank form. No error or banner is shown. - Privacy: VerifiMe never returns document numbers or raw identity document data to your application. The
customerContextyou supply is used only to pre-fill the onboarding form and is not included in webhook payloads.
Example
POST /v1/user/invite
{
"email": "jane.smith@example.com",
"code": "ORGCODE123",
"referenceData": "app-ref-456",
"customerContext": {
"firstName": "Jane",
"familyName": "Smith",
"preferredContactNumber": "+61 412345678",
"address": "42 Wallaby Way, Sydney NSW 2000, Australia"
}
}