The purpose of this page is to provide guide how to work with GetID sandbox.
Sandbox is a test environment deployed on GetID servers to familiarize customer's developers with verification services provided by GetID.
You are able to interact with sandbox using our SDKs (iOS, Web and Android) or REST API. Admin Panel is avalable as well as a part of sandbox.
First of all you should have an address of the sandbox and API key provided by GetID.
There are links to SDK Documentation and example-projects.
There is API specification in openAPI standard.
There are example with minimal data passed to GetID to complete verification:
To extract data from photo of a document:
{
"application": {
"documents": [
{
"id": "string",
"issuingCountry": "JPN",
"documentType": "id-card",
"files": [
{
"id": "string",
"kind": "front",
"uri": "data:image/png;base64,R0lGODlhDAAMAK..."
}
]
}
]
},
"verificationTypes": [
"data-extraction"
]
}To request PEPs:
{
"application": {
"fields": [
{
"contentType": "string",
"content": "Artem",
"category": "First name"
},
{
"contentType": "string",
"content": "Gerus",
"category": "Last name"
},
{
"contentType": "string",
"category": "Date of birth",
"content": "1991-02-03"
}
]
},
"verificationTypes": [
"watchlists"
]
}There is example to post application to verification using curl. This example contains images of both sides of Estonian id card.
NB! Change before execute:
<getidserver>with address of the sandbox provided by GetID.1231223with the authorization bearer provided by GetID.
You are able to get the verification result in two ways:
- by callback;
- by API;
To get the result by callback you must specify callback URL in Admin Panel (Settings->Callback URL).
Also you are able to request result using API method /api/v1/application/{{appId}}.
The result is in Application format.
Example:
{
"id": "5e62110968e3fb4d655756d1",
"metadata": {
"externalId": "ID-2345",
"platform": "android",
"clientName": "my-api-client",
"clientVersion": "1.0.0",
"labels": {
"my-custom-meta-name-1": "custom-value-1",
"my-custom-meta-name-2": "custom-value-2"
}
},
"application": {
"fields": [
{
"contentType": "string",
"content": "First name",
"category": "Artem"
},
{
"contentType": "string",
"content": "Last name",
"category": "Gerus"
},
{
"contentType": "sex",
"content": "male",
"category": "Gender"
},
{
"contentType": "bool",
"content": "true",
"category": "Agree on something"
}
],
"documents": [
{
"id": "string",
"issuingCountry": "JPN",
"documentType": "id-card",
"files": [
{
"id": "string",
"kind": "front",
"uri": "data:image/png;base64,R0lGODlhDAAMAK..."
}
]
}
],
"selfie": {
"files": [
{
"id": "string",
"uri": "data:video/webm;base64,<data>"
}
]
}
},
"verificationTypes": [
"watchlists",
"face-matching",
"data-extraction"
],
"processingState": "done",
"overallResult": {
"status": "declined",
"comments": [
{
"service": "face-matching",
"status": "approved",
"comment": "faces are similar"
},
{
"service": "watchlists",
"status": "declined",
"comment": "found 2 reports against the person"
},
{
"service": "data-extraction",
"status": "approved",
"comment": "data was extracted"
}
],
"validationDate": "2020-03-17T20:28:37.061Z"
},
"servicesResults": {
"faceMatching": {
"comment": "Faces are not similar",
"verifier": "Facemelter",
"status": "declined",
"processingState": "done",
"results": [
{
"files": [
"face-abc1",
"document-photo-qwe7"
],
"score": 0.3
}
],
"settings": {
"declineThreshold": 0.4,
"needsReviewThreshold": 0.6
}
},
"dataExtraction": {
"comment": "Data was extracted",
"verifier": "Regula",
"status": "approved",
"extracted": [
{
"documentId": "passport-1",
"ocr": [
{
"contentType": "string",
"category": "First name",
"content": "Joe"
},
{
"contentType": "string",
"category": "First name",
"content": "Джо",
"locale": "ru_RU"
},
{
"contentType": "string",
"category": "Last name",
"content": "Black"
}
],
"mrz": [
{
"contentType": "string",
"category": "First name",
"content": "James"
},
{
"contentType": "string",
"category": "Last name",
"content": "Black"
}
],
"nfc": [
{
"contentType": "string",
"category": "First name",
"content": "Joe"
},
{
"contentType": "string",
"category": "Last name",
"content": "Black"
}
]
},
{
"documentId": "driving-licence-1",
"ocr": [
{
"contentType": "string",
"category": "First name",
"content": "Joe"
},
{
"contentType": "string",
"category": "Address",
"content": "May street"
}
]
}
]
},
"crossChecking": {
"comment": "string",
"verifier": "string",
"status": "declined",
"processingState": "done",
"fieldChecking": [
{
"category": "First name",
"field": "John",
"extracted": "Joanna",
"equal": false,
"documentId": "passport-1"
},
{
"category": "Last name",
"field": "Doe",
"extracted": "",
"equal": false,
"documentId": "passport-1"
},
{
"category": "Date of birth",
"field": "1999-09-31",
"extracted": "1999-09-31",
"equal": true,
"documentId": "passport-1"
},
{
"category": "Address",
"field": "May street",
"extracted": "April street",
"equal": false,
"documentId": "driving-licence-1"
}
]
},
"watchlists": {
"comment": "string",
"verifier": "string",
"status": "declined",
"processingState": "done",
"sentFields": [
"First name",
"Last name",
"Date of birth"
],
"records": [
{}
]
}
},
"responseCode": 200
}The complete description of application format is Application.
To review results of verification services you should use the Admin Panel.
By default Admin Panel address is the same as the address of the sandbox provided by GetID.