Preventor docs
Identity Verification
Identity Verification
  • getting started
    • Overview
  • web - client-side SDKs
    • HTML + Javascript
    • Angular
    • React
    • Vue.js
  • mobile - client-side SDKs
    • iOS
    • Android
  • Server
    • API Reference
      • Security
      • Invitations link
      • IDV Tickets
    • Webhooks
      • IDV Tickets
      • Invitations link
  • Resources
    • Document image quality requirements
Powered by GitBook
On this page

Was this helpful?

  1. Server
  2. API Reference

IDV Tickets

PreviousInvitations linkNextWebhooks

Last updated 1 year ago

Was this helpful?

Ticket Details

get

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.

Authorizations
Path parameters
ticketstringRequired

Your ticket's ID

Example: YOUR_TICKET
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
GET /id/v1/identity/transactions/{ticket} HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content

Images

get

This service return all ticket's images, sent by the user and processed ones.

Images uploaded by user are its selfies and document image(s).

Processed images are document's extracted images. Their availability depends entirely on user's document type. These images are portrait, ghost portrait, signature.

Authorizations
Path parameters
ticketstringRequired

Your ticket's ID

Example: YOUR_TICKET
Query parameters
typestringOptional

Specifies which images must be retrieved. Its values are: SELF_PORTRAITS, DOCUMENT, DOCUMENT_PORTRAIT, DOCUMENT_SIGNATURE, DOCUMENT_GHOST_PORTRAIT, ALL

To retrieve various types, these values can be concatenated with a comma (,); no spaces inbetween

Example: ALL
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
get
GET /id/v1/identity/transactions/{ticket}/images HTTP/1.1
Host: api-sandbox.preventor.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content
  • GETTicket Details
  • GETImages