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.
\n(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.
\n(1) The first step is tokenized authentication using your credentials.
\n(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.
\n(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.
\n(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.
\n(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.
\n(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
\n(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.
\n(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.
\n(8) Finally, Preventor's identity management platform allows you to manage invitations, IDV tickets, and analytics dashboard queries.
\nYour credential's unique key
\n","type":"text"},{"key":"x-tenant","value":"YOUR_TENANT","description":"Your credential's tenant value
\n","type":"text"},{"key":"x-env","value":"YOUR_ENV","description":"Your credential's env value
\n","type":"text"},{"key":"x-banknu","value":"YOUR_BANKNU","description":"Your credential's banknu value
\n","type":"text"},{"key":"user-agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"},{"key":"x-interface","value":"postman-interface-v1.0.0","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/auth/token","description":"Our services require you to be authenticated and authorized, that's why you must generate your access token first. In order to create this token, you must provide your credential.
\nYour credential consists of three values: you api key, your secret, your tenant, your env and your banknu.
\nYour api key must be sent as a header, and also as your username along with your secret as Basic authorization.
\nYour tenant, env and banknu must be sent as headers values.
\n","urlObject":{"path":["v1","identity","auth","token"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d4ed7cc-5946-48c5-9155-2f3bdbd20ec0"},{"name":"Authentication mobile","event":[{"listen":"test","script":{"id":"471b789c-537d-4c80-afcb-38fe9fddec9c","exec":["const resCode = pm.response.code","","if (resCode === 200 || resCode === 201) {"," const body = pm.response.json();"," pm.environment.set(\"token\", body.token);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"057de392-2dd2-4d80-a576-5b3fbc7c4de2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_API_KEY"},{"key":"password","value":"YOUR_SECRET"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","description":"Your credential's unique key
\n","type":"text"},{"key":"x-tenant","value":"YOUR_TENANT","description":"Your credential's tenant value
\n","type":"text"},{"key":"x-env","value":"YOUR_ENV","description":"Your credential's env value
\n","type":"text"},{"key":"x-banknu","value":"YOUR_BANKNU","description":"Your credential's banknu value
\n","type":"text"},{"key":"user-agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"},{"key":"x-interface","value":"postman-interface-v1.0.0","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/auth/token","description":"Our services require you to be authenticated and authorized, that's why you must generate your access token first. In order to create this token, you must provide your credential.
\nYour credential consists of three values: you api key, your secret, your tenant, your env and your banknu.
\nYour api key must be sent as a header, and also as your username along with your secret as Basic authorization.
\nYour tenant, env and banknu must be sent as headers values.
\n","urlObject":{"path":["v1","identity","auth","token"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"057de392-2dd2-4d80-a576-5b3fbc7c4de2"}],"id":"84b08e15-72b6-4b60-951b-861d45397939","_postman_id":"84b08e15-72b6-4b60-951b-861d45397939","description":""},{"name":"Invitations","item":[{"name":"Check","id":"34e194c4-57b9-465d-bd2c-de0d645a8501","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"body":{"mode":"raw","raw":"{\n \"unique\": \"escudero183.1@hotmail.com\",\n \"email\": \"escudero183.1@hotmail.com\",\n \"delivery_method\": \"EMAIL\",\n \"type\": \"ID\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-id.preventor.com/v1/identity/invitations/check","description":"This service verifies the availability of a specific unique identifier or email for a new registration within the invitation flow. It ensures that the provided credentials are valid and not currently associated with an existing active process.
\nThe request payload requires a unique identifier and an email to perform the validation. You must specify the delivery_method, which can be EMAIL or PHONE, and the process type (e.g., ID) to be validated.
\nThis endpoint is used as a preliminary validation step before calling the invitation creation service (register), ensuring that the recipient is eligible for a new ticket process.
\n","urlObject":{"path":["v1","identity","invitations","check"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"34e194c4-57b9-465d-bd2c-de0d645a8501"},{"name":"Register","id":"bb425bfe-b65e-41e5-8826-7321a8fe0e8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"body":{"mode":"raw","raw":"{\n \"delivery_method\": \"PHONE\",\n \"phone\": {\n \"phone_number_prefix\": \"+1\",\n \"phone_number\": \"1234567890\"\n },\n \"deliver_invitation\": true,\n \"broker\": \"7c74e158-8de1-4c0c-afcb-584f5d9c8b99\",\n \"unique\": \"f342d096-6d1b-4981-8da8-be78eyp6g-s95\",\n \"flow\": \"WF-07_784d636c-8241-401a-a0f0-79cdfd74d4ec_2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-id.preventor.com/v1/identity/invitations/users/register","description":"This service creates an invitation to the specified recipient. Invitation can be delivered by phone or email.
\nIt can be specified on request payload (delivery_method) which can be PHONE, EMAIL or ASSISTANT. The later is sent as email, too.
\nWhen settings your delivery_method as PHONE, you have to set the recipient on phone, or on email otherwise.
\nIf you need your invitation to be delivered rightaway, you have to set deliver_invitation to true.
\nIn case this invitation belongs to a broker of your company, you can specify it by adding its ID on broker.
\nYou have to specify the flow which must be executed when user starts its ticket process.
\n","urlObject":{"path":["v1","identity","invitations","users","register"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb425bfe-b65e-41e5-8826-7321a8fe0e8f"},{"name":"Send","id":"12584bb6-d22f-4775-8be5-3aa27060c415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api-id.preventor.com/v1/identity/notifications/invitation/:id/send","description":"This service sends the invitation to the specified recipient
\n","urlObject":{"path":["v1","identity","notifications","invitation",":id","send"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"description":{"content":"Your invited user recipient, which can be either an email or a phone number
\n","type":"text/plain"},"type":"any","value":"YOUR_INVITATION_RECIPIENT","key":"id"}]}},"response":[],"_postman_id":"12584bb6-d22f-4775-8be5-3aa27060c415"},{"name":"Update","id":"50c9a436-e08e-4c88-9f4e-2041562eb059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"PATCH","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"body":{"mode":"raw","raw":"{\n \"delivery_method\": \"PHONE\",\n \"phone\": {\n \"phone_number\": \"1234567890\",\n \"phone_country_code\":\"US\"\n },\n \"unique\": \"cbed4c28-399a-4504-a6u7-6gs435-3d9\",\n \"broker\": \"2323523-05e8-433b-9504-829358780111\",\n \"flow\": \"WF-07_784d636c-8241-401a-a0f0-79cdfd74d4ec_4\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-id.preventor.com/v1/identity/invitations/users/:recipient","description":"This services allows you to update specified invitation. Invitation can be delivered by phone or email.
\nIt can be specified on request payload (delivery_method) which can be PHONE, EMAIL or ASSISTANT. The later is sent as email, too.
\nWhen settings your delivery_method as PHONE, you have to set the recipient on phone, or on email otherwise.
\nIn case this invitation belongs to a broker of your company, you can specify it by adding its ID on broker.
\nYou have to specify the flow which must be executed when user starts its ticket process.
\n","urlObject":{"path":["v1","identity","invitations","users",":recipient"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"description":{"content":"Your invited user recipient, which can be either an email or a phone number
\n","type":"text/plain"},"type":"any","value":"YOUR_INVITATION_RECIPIENT","key":"recipient"}]}},"response":[],"_postman_id":"50c9a436-e08e-4c88-9f4e-2041562eb059"},{"name":"Delete","id":"33358eed-d5c0-4eb1-8d3e-71b9ed371966","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/invitations/users/:recipient","description":"This service allows you to remove an invitation.
\n","urlObject":{"path":["v1","identity","invitations","users",":recipient"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"description":{"content":"Your invited user recipient, which can be either an email or a phone number
\n","type":"text/plain"},"type":"any","value":"YOUR_INVITATION_RECIPIENT","key":"recipient"}]}},"response":[],"_postman_id":"33358eed-d5c0-4eb1-8d3e-71b9ed371966"},{"name":"Activities","event":[{"listen":"prerequest","script":{"id":"2f8b654b-deeb-4532-9a15-93820a4d165b","exec":[""],"type":"text/javascript"}}],"id":"3dc2831e-96b5-4729-a00b-d4510bc371e7","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"user-agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/invitations/logs/:invitation_id/activities","description":"This service returns all activities made on invitation until now.
\n","urlObject":{"path":["v1","identity","invitations","logs",":invitation_id","activities"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"description":{"content":"Your invitation ID
\n","type":"text/plain"},"type":"any","value":"YOUR_INVITATION_ID","key":"invitation_id"}]}},"response":[],"_postman_id":"3dc2831e-96b5-4729-a00b-d4510bc371e7"}],"id":"005abbf5-5f23-46d0-ba87-822cf9a95d1b","description":"All services related to Invitations maintenance and delivery.
\n","event":[{"listen":"prerequest","script":{"id":"e4ab5b40-5d0b-4eec-8ade-8b6cf256a7df","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3262649a-af01-4f1e-8f64-97c7a7d04548","type":"text/javascript","exec":[""]}}],"_postman_id":"005abbf5-5f23-46d0-ba87-822cf9a95d1b"},{"name":"Preventor ID Tickets","item":[{"name":"Ticket Details","event":[{"listen":"prerequest","script":{"id":"2f8b654b-deeb-4532-9a15-93820a4d165b","exec":[""],"type":"text/javascript"}}],"id":"804a9e06-3cf7-4e72-9d65-ad41badae262","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","description":"Your credential's api key
\n","type":"text"},{"key":"user-agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/transactions/:ticket","description":"This service returns your ticket information, containing ticket's summary details, user's personal information, its document information, document's lexical information, tracked device, and process flow details.
\n","urlObject":{"path":["v1","identity","transactions",":ticket"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"description":{"content":"Your ticket's ID
\n","type":"text/plain"},"type":"any","value":"YOUR_TICKET_ID","key":"ticket"}]}},"response":[],"_postman_id":"804a9e06-3cf7-4e72-9d65-ad41badae262"},{"name":"Images","id":"3b4f31f0-4424-493b-ae0a-3ebfd291f0cc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","type":"text","description":"Your credential's api key
\n"},{"key":"User-Agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.77 Safari/537.36","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/transactions/:ticket/images?type=ALL","description":"This service return all ticket's images, sent by the user and processed ones.
\nImages uploaded by user are its selfies and document image(s).
\nProcessed images are document's extracted images. Their availability depends entirely on user's document type. These images are portrait, ghost portrait, signature.
\n","urlObject":{"path":["v1","identity","transactions",":ticket","images"],"host":["https://api-id.preventor.com"],"query":[{"description":{"content":"Specifies which images must be retrieved. Its values are: SELF_PORTRAITS, DOCUMENT, DOCUMENT_PORTRAIT, DOCUMENT_SIGNATURE, DOCUMENT_GHOST_PORTRAIT, ALL
\nTo retrieve various types, these values can be concatenated with a comma (,); no spaces inbetween
\n","type":"text/plain"},"key":"type","value":"ALL"}],"variable":[{"description":{"content":"Your ticket's ID
\n","type":"text/plain"},"type":"any","value":"YOUR_TICKET_ID","key":"ticket"}]}},"response":[],"_postman_id":"3b4f31f0-4424-493b-ae0a-3ebfd291f0cc"}],"id":"3d842d6c-bc2c-4d6c-85f5-54319654e66d","description":"All services for retrieving Tickets results and resources.
\n","event":[{"listen":"prerequest","script":{"id":"85398789-2e54-4dd1-8aa3-baaeed7e2372","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"36c86ecf-0cab-4dbf-99cc-2dd252a432ef","type":"text/javascript","exec":[""]}}],"_postman_id":"3d842d6c-bc2c-4d6c-85f5-54319654e66d"},{"name":"Webhooks","item":[{"name":"List","id":"7d278f2c-94b1-4026-810f-44a3096c5036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"YOUR_API_KEY","description":"Your credential's api key
\n"},{"key":"user-agent","value":"API v1.1"}],"url":"https://api-id.preventor.com/v1/identity/settings/webhooks","description":"This service list all of your registered webhooks.
\n","urlObject":{"path":["v1","identity","settings","webhooks"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d278f2c-94b1-4026-810f-44a3096c5036"},{"name":"Register","id":"ba4e6727-1746-430a-b269-90078a211dd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"PUT","header":[{"key":"x-api-key","value":"YOUR_API_KEY","description":"Your credential's api key
\n","type":"text"},{"key":"user-agent","value":"API v1.1","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"authorization\": {\r\n \"type\": \"API_KEY\",\r\n \"value\": {\r\n \"value\": \"API-KEY-FOR-PVT-ID\",\r\n \"key\": \"x-custom-api-key\"\r\n }\r\n },\r\n \"type\": \"WH_001\",\r\n \"secret\": \"YOUR-32-BYTES-SECRET\",\r\n \"url\": \"YOUR-WEBHOOK-URL\",\r\n \"events\": [\r\n \"ticket.verification.completed\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-id.preventor.com/v1/identity/settings/webhooks","description":"This service registers or updates your webhook, by specifying your webhook url.
\nYou can register a secured webhook service. In this case, you have to specify your authorization mechanism, which can be one of these 3 authorization types: Basic authorization, Bearer token and API keys.
\nYour authorization must contain following fields:
\nA type (webhook type) must be specified, and it only can be one of both values:
WH_001, that is used for delivering tickets results, and WH_002, which delivers invitations results.
Your message can be delivered ciphered, by setting a symmetric secret, which in turn, must be 32 bytes size long. Please, refer to our Webhook documentation for more details of this feature:
\nhttps://docs.preventor.com/server/webhooks/idv-tickets
\n","urlObject":{"path":["v1","identity","settings","webhooks"],"host":["https://api-id.preventor.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba4e6727-1746-430a-b269-90078a211dd8"},{"name":"Remove","id":"6cc23b0f-7412-4a49-9f0f-4e620fce863d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"YOUR_API_KEY","description":"Your credential's api key
\n","type":"text"},{"key":"user-agent","value":"API v1.1","type":"text"}],"url":"https://api-id.preventor.com/v1/identity/settings/webhooks/:id","description":"This service removes your registered webhook.
\n","urlObject":{"path":["v1","identity","settings","webhooks",":id"],"host":["https://api-id.preventor.com"],"query":[],"variable":[{"type":"any","value":"YOUR_WEBHOOK_ID","key":"id"}]}},"response":[],"_postman_id":"6cc23b0f-7412-4a49-9f0f-4e620fce863d"}],"id":"c012e964-7a97-421d-866f-af0e8e777f6c","description":"Services for your webhooks to be configured
\n","_postman_id":"c012e964-7a97-421d-866f-af0e8e777f6c"}],"event":[{"listen":"prerequest","script":{"id":"1a173874-f5ae-426f-ae9f-a81b30bd0e9f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31200720-8b46-41d0-a024-ad2f59e1aa76","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api-id.preventor.com","type":"string"},{"key":"api-key","value":"YOUR_API_KEY","type":"string"},{"key":"secret","value":"YOUR_SECRET","type":"string"},{"key":"tenant","value":"YOUR_TENANT","type":"string"},{"key":"env","value":"YOUR_ENV","type":"string"},{"key":"banknu","value":"YOUR_BANKNU","type":"string"},{"key":"bearer_token","value":"YOUR_TOKEN","type":"string"},{"key":"invitation_id","value":"YOUR_INVITATION_ID","type":"string"},{"key":"invitation_recipient","value":"YOUR_INVITATION_RECIPIENT","type":"string"},{"key":"ticket_id","value":"YOUR_TICKET_ID","type":"string"},{"key":"webhook_id","value":"YOUR_WEBHOOK_ID","type":"string"}]}