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.

Register

post

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-api-keystringOptional

Your credential's api key

Example: YOUR_API_KEY

User-AgentnumberOptionalExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36

Body

objectOptionalExample:

{"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"}

Responses

200

Successful response

application/json

post/id/v1/identity/invitations/users/register

POST /id/v1/identity/invitations/users/register HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "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"
}

200

Successful response

Send

post

This service sends the invitation to the specified recipient

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recipientstringRequired

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

Example: YOUR_INVITATION_RECIPIENT

Header parameters

x-api-keystringOptional

Your credential's api key

Example: YOUR_API_KEY

User-AgentnumberOptionalExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36

Body

objectOptional

Responses

200

Successful response

application/json

post/id/v1/identity/notifications/invitation/{recipient}/send

POST /id/v1/identity/notifications/invitation/{recipient}/send HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

200

Successful response

Delete

delete

This service allows you to remove an invitation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recipientstringRequired

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

Example: YOUR_INVITATION_RECIPIENT

Header parameters

x-api-keystringOptional

Your credential's api key

Example: YOUR_API_KEY

User-AgentnumberOptionalExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36

Responses

200

Successful response

application/json

delete/id/v1/identity/invitations/users/{recipient}

DELETE /id/v1/identity/invitations/users/{recipient} HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

Update

patch

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

recipientstringRequired

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

Example: YOUR_INVITATION_RECIPIENT

Header parameters

x-api-keystringOptional

Your credential's api key

Example: YOUR_API_KEY

User-AgentnumberOptionalExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36

Body

objectOptionalExample:

{"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"}

Responses

200

Successful response

application/json

patch/id/v1/identity/invitations/users/{recipient}

PATCH /id/v1/identity/invitations/users/{recipient} HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "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"
}

200

Successful response

Activities

get

This service returns all activities made on invitation until now.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

invitation_idstringRequired

Your invitation ID

Example: YOUR_INVITATION

Header parameters

x-api-keystringOptional

Your credential's api key

Example: YOUR_API_KEY

user-agentstringOptionalExample: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36

Responses

200

Successful response

application/json

get/id/v1/identity/invitations/logs/{invitation_id}/activities

GET /id/v1/identity/invitations/logs/{invitation_id}/activities HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

PreviousSecurity NextIDV Tickets

Last updated 2 years ago