Invitations link

Integration via identity verification API using invite links

In this document, you will learn how to seamlessly integrate Preventor ID with your system by using invite links for your customers to perform self-service identity verification.

(0) The following flow indicates as a zero step that you should use the configuration platform to configure and customize Preventor ID according to your workflows and business cases.

(1) The first step is tokenized authentication using your credentials.

(2) Then you must register the invitation with the necessary attributes to be able to send the invitation in the shipping method you choose and make the verification link with your client.

(3) Sending the invitation is optional and you can choose to use the link and paste it in your processes or send it through your own channels.

(4) Once the invite link has reached your client, this process should continue with the self-service identity verification process following the instructions of the web-sdk. Preferably on a responsive device, however this is also up to you and can be configured on the platform.

(5) To know when the client is done with the identity verification, you can choose to set up a notification webhook or you can check the invitation status via the API periodically.

(5.1) If the validity time of the invitation expires or you want to make changes to an invitation or delete it, you can do so using the Resend, Edit and Delete APIs

(6) When you have been able to determine that the invitation and identity verification have finished, either by the webhook or by the API query, you will be able to get the results of the identity verification and images using the IDV ticket id, which is part of the results of the invitation.

(7) At this point, you can continue with your business flow and/or you can update your KYC system using the data obtained from the result of the identity verification ticket and the information of your client's identity document.

(8) Finally, Preventor's identity management platform allows you to manage invitations, IDV tickets, and analytics dashboard queries.

Invitation flow

Register

This service creates an invitation to the specified recipient. Invitation can be delivered by phone or email.

It can be specified on request payload (delivery_method) which can be PHONE, EMAIL or ASSISTANT. The later is sent as email, too.

When settings your delivery_method as PHONE, you have to set the recipient on phone, or on email otherwise.

In case this invitation belongs to a broker of your company, you can specify it by adding its ID on broker.

You have to specify the flow which must be executed when user starts its ticket process.

POSThttps://api-sandbox.preventor.com/id/v1/identity/invitations/users/register

Authorization

bearerAuth

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api-sandbox.preventor.com/id/v1/identity/invitations/users/register', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "delivery_method": "PHONE",
      "phone": {
        "phone_number_prefix": "+1",
        "phone_number": "1234567890"
      },
      "broker": "7c74e158-8de1-4c0c-afcb-584f5d9c8b99",
      "unique": "f342d096-6d1b-4981-8da8-be78eyp6g-s95",
      "flow": "WF-07_784d636c-8241-401a-a0f0-79cdfd74d4ec_2"
    }),
});
const data = await response.json();

Send

This service sends the invitation to the specified recipient

POSThttps://api-sandbox.preventor.com/id/v1/identity/notifications/invitation/{recipient}/send

Authorization

bearerAuth

Path parameters

recipient*string

Your invited user recipient, which can be either an email or a phone number

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api-sandbox.preventor.com/id/v1/identity/notifications/invitation/{recipient}/send', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Delete

This service allows you to remove an invitation.

DELETEhttps://api-sandbox.preventor.com/id/v1/identity/invitations/users/{recipient}

Authorization

bearerAuth

Path parameters

recipient*string

Your invited user recipient, which can be either an email or a phone number

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api-sandbox.preventor.com/id/v1/identity/invitations/users/{recipient}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update

This services allows you to update specified invitation. Invitation can be delivered by phone or email.

It can be specified on request payload (delivery_method) which can be PHONE, EMAIL or ASSISTANT. The later is sent as email, too.

When settings your delivery_method as PHONE, you have to set the recipient on phone, or on email otherwise.

In case this invitation belongs to a broker of your company, you can specify it by adding its ID on broker.

You have to specify the flow which must be executed when user starts its ticket process.

PATCHhttps://api-sandbox.preventor.com/id/v1/identity/invitations/users/{recipient}

Authorization

bearerAuth

Path parameters

recipient*string

Your invited user recipient, which can be either an email or a phone number

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api-sandbox.preventor.com/id/v1/identity/invitations/users/{recipient}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "delivery_method": "PHONE",
      "phone": {
        "phone_number": "1234567890",
        "phone_country_code": "US"
      },
      "unique": "cbed4c28-399a-4504-a6u7-6gs435-3d9",
      "broker": "2323523-05e8-433b-9504-829358780111",
      "flow": "WF-07_784d636c-8241-401a-a0f0-79cdfd74d4ec_4"
    }),
});
const data = await response.json();

Activities

This service returns all activities made on invitation until now.

GEThttps://api-sandbox.preventor.com/id/v1/identity/invitations/logs/{invitation_id}/activities

Authorization

bearerAuth

Path parameters

invitation_id*string

Your invitation ID

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api-sandbox.preventor.com/id/v1/identity/invitations/logs/{invitation_id}/activities', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();