Create a customer verification invitation

Creates a verification session and returns a tracking reference and invitation links. Send the inviteUrl or qrCodeUrl to your customer to begin the VerifiMe onboarding wizard.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Customer email address

Formatemail

code*string

Organisation code

referenceData?string

Arbitrary string returned in the webhook metadata field. Use this to correlate the webhook event with your internal record (for example, an application ID).

customerContext?

Invitation context for this verification session. Personal detail fields pre-fill the onboarding wizard and personalise the invitation email. All personal detail fields are optional suggestions; the customer can change them during onboarding.

Once-consumable: Pre-fill values are applied on the first load of the onboarding wizard only. If the customer revisits the invitation link, the wizard starts fresh without pre-filled values. callbackUrl is a post-completion routing field and is not subject to this constraint.

Privacy: VerifiMe does not return customer document numbers or other sensitive identity data to partners via the API or webhook.

Validation: Name fields accept Latin letters, spaces, apostrophes, and hyphens only. Invalid values will return a 400 response.

sendInvitationEmail?boolean

When true, VerifiMe sends a branded invitation email to the customer. When false (default), you are responsible for delivering the inviteUrl or qrCodeUrl to the customer.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/v1/user/invite" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "code": "string"  }'

{  "trackingReference": "7ea40290-44b7-424e-babb-31da7ca1dcd1",  "inviteUrl": "https://portal.stage.verifime.com/sign-up/track-id/7ea40290-44b7-424e-babb-31da7ca1dcd1",  "qrCodeUrl": "https://qr-code.dev.verifime.com/qr?url=https%3A%2F%2Fportal.stage.verifime.com%2Fsign-up%2Ftrack-id%2F7ea40290-44b7-424e-babb-31da7ca1dcd1"}

{  "request": {    "email": "test@example.com",    "code": "TESTCODE",    "referenceData": null,    "customerContext": {      "fullName": null,      "firstName": "Jack test2",      "familyName": "Smith",      "middleName": null,      "dateOfBirth": null,      "preferredContactNumber": null,      "address": null    },    "sendInvitationEmail": false  },  "validationResults": [    {      "path": "",      "name": "code",      "resultType": "Error",      "resultName": "InvalidOrganisationCodeLength",      "resultScope": "Field",      "message": "Supplied organisation code is not the correct length"    },    {      "path": "customerContext",      "name": "firstName",      "resultType": "Error",      "resultName": "PersonNameInvalidCharacter",      "resultScope": "Field",      "message": "A person name is not allowed to have the character at position 9"    }  ]}

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`