Overview

KYC Process

1 ) Create a Person: An Email will be sended automatically with documents request

2 ) Person must upload all personal document requiered for the Organization.

3 ) Dokstor validate MRZ Data, Selfie, Proof of address and identifies a fraudulent documentation automatically

Request

Dokstor’s API its using the standard HTTP verbs and services REST

Each type of request uses a different HTTP method.

  • GET: queries data. It does not modify the status of the entities.
  • POST: adds or updates one or more entities.
  • DELETE: deletes one or more entities.

The request input data can be present in three different places.

  • URL path: usually only for entity ids (ie. DELETE /user/{userid}). Applies to all HTTP methods.
  • URL query string: a list of (usually optional) query parameters (ie. GET /user?first=1&max=50). Applies to GET requests.
  • Body: a JSON object with entity data. Applies to POST requests.

Response

A response returns OK (200 status code) or an error (any other status code). An OK always returns a JSON object in the body of the response. The JSON object can be empty or data structure depending on the endpoint called. An error will usually return 

Authentication

Before to get Auth, you must have an ORG.

Logs in a user. Returns the person information and a JSON Web Token for secured calls.

  • Request Example:

after submitting a request a typical response is shown below

  • Example Response (JSON)

The value of the field ‘token’ from the response needs to be included in all the calls to the API.

JOB API need Token for secured calls.  You can generated it manually in your org’s admin section

JOB API Auth : 

Generate API KEY

Step 1:

Logs with your org user and select “admin” into menu option

Step 2 

Select the option API KEY

Click in API KEYS

Step 3:

Click in “ADD A NEW API KEY”

Step 4: 

Set your API KEY ROLES and write a name for your api-key and click at the button “GENERATE”

Last Step:

Copy your KEY and now, you are ready started to use JOB API

JOB API Request and Response

Job API is Asynchronous, you should verify your callback URL.

Request:

Parameters

ParameterTypeRequiredDescription
namestringtrueName
surnamestringtrueSurname
genderstringtrueGender. Can be MALE or FEMALE
nationalitystringtrueNationality in 3 character ISO 3116-1 format
addressstringfalseAddress
addressCitystringfalseAddress City
addressStatestringfalseAddress State
addressZipCodestringfalseAddress Zip Code (Post code)
addressCountrystringfalseAddress Country
birthDatestring(date-time)falseDate of birth
emailstringtrueEmail
phonestringfalsePhone number
documentIdstringfalseID of the document
documentTypestringfalseType of document. Can be NATIONAL_ID or PASSPORT
documentIssueDatestring(date-time)falseDocument issue date
documentExpirationDatestring(date-time)falseDocument expiration date
callbackstringfalseInsert here the URL of your service to be automatically invoked when the job finishes. The information will be sent as a POST request, like shown in the screenshot below
expirationstring(date-time)falseExpiration date of the job. It will be deleted on the chosen date
documents[Object Document]falseObject Document

API Callback response

This callback will send back the job id. Then you will need to call the endpoint Get a Job Information to get the rest of the job.

Key concepts


Let get your familiar with relevant terminology to help you understand Dokstor easily

Person:

Person is the way to register a client and send a request, validate documents and AML Validation

Type of Person. Can be Personal, Employee or Corporate.

JOB API:

With JOB API we can send all documentation manually via API without backoffices in only a way

If you want to know how generate a JOB API KEY click here

AML

Coming soon…

Welcome

Welcome to Dokstor,

The first world’s leading documents verification engine. 
In this Quick starts you will find all you need to started running verifications easily.

And if you are looking for a better way to customize your workflow you may need check our API Reference Guide