API Reference
POST /v1/user/invite
Create a tracking reference for customer verification
Purpose
Create a tracking reference for customer verification.
Authentication: None required (public endpoint)
Request Body
{
"email": "customer@example.com",
"code": "ORGCODE123",
"referenceData": "your-application-id",
"customerContext": {
"firstName": "Jane",
"familyName": "Smith",
"middleName": "Marie",
"fullName": "Jane Marie Smith",
"dateOfBirth": "1990-01-15",
"preferredContactNumber": "+61 412345678",
"address": "42 Wallaby Way, Sydney NSW 2000, Australia"
},
"sendInvitationEmail": false
}Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | String | Yes | Customer's email address |
code | String | Yes | Your VerifiMe organisation code |
referenceData | String | No | Opaque string returned in webhook metadata field (use for correlation) |
customerContext | Object | No | Customer details to pre-fill the onboarding wizard. See Pre-filling Customer Details. |
sendInvitationEmail | Boolean | No | If true, sends a branded invitation email to the customer via VerifiMe. Default: false. |
customerContext Fields
| Field | Type | Description |
|---|---|---|
firstName | String | Customer's first name |
familyName | String | Customer's family name |
middleName | String | Customer's middle name |
fullName | String | Customer's full name (alternative to first/family name fields) |
dateOfBirth | String (ISO 8601) | Customer's date of birth, e.g. "1990-01-15" |
preferredContactNumber | String | Customer's phone number, e.g. "+61 412345678" |
address | String | Free-text address for pre-fill resolution, e.g. "42 Wallaby Way, Sydney NSW 2000, Australia" |
All customerContext fields are optional. Provide as many as are available to improve the customer's onboarding experience.
Response
{
"trackingReference": "uuid",
"inviteUrl": "https://portal.verifime.com/sign-up/track-id/uuid",
"qrCodeUrl": "https://..."
}| Field | Type | Description |
|---|---|---|
trackingReference | String (UUID) | Unique identifier for this verification session |
inviteUrl | String (URL) | Direct link to VerifiMe customer portal |
qrCodeUrl | String (URL) | QR code image URL that encodes the inviteUrl |
Important: The
referenceDataparameter is critical for webhook correlation. Whatever string you pass here will be returned in the webhook'smetadatafield.