Before it is possible to send any request successfully, the value for the API Key has to be set in your environment. With the API Key set, the first request must be to authenticate and obtain a JWT. The JWT is necessary for accessing the API with any subsequent request.
- Home
- Documentation
Identify API Ver. 1.0.3
Last updated: Sep 18th, 2024
Welcome to Identify VideoIdent API Documentation
Identify -> The Identity Verification Platform
NOTE: This documentation only applies to our products Identify VideoIdent.
Introduction
Identify exposes its identity verification services via a standardized programmatic interface to its clients. We offer a RESTful API that is based on HTTP requests and JSON responses.
This documentation provides you with an overview of the API endpoints and information on implementing our services in your own IT infrastructure.
What is REST API ?
An API is an Application Programming Interface - in short, it’s a set of rules that lets programs talk to each other, exposing data and functionality across the internet in a consistent format.
REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term 'REST API', they are generally referring to an API accessed via HTTP protocol at a predefined set of URLs.
These URLs represent various resources - any information or content accessed at that location, which can be returned as JSON, HTML, audio files, or images. Often, resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT and DELETE.
What is videoident?
Videoident allows to verify the identity of a person along with a verification if the document used is genuine in a process guided by an Ident Specialist. The user and the Ident Specialist are interacting with each other during this process using a video-chat.
Identify Videoident can be used with a web browser by the user.
Target Audience
This document is targeted at developers of third party companies who want to integrate the Identify verification service into their own applications.
Terminology
We would like to introduce our terminalogy used throughout this documentation for a better understanding of the data entities you will be handling when requesting our API service:
| Term | Description |
|---|---|
| Partner | Partner of Identify who uses the services of Identify to verify the identity of their customers. |
| API Key | The API key is required for authenticating your application and accessing our REST services. You receive this value during Identify account setup. Never share this value with anyone, not even with us! |
| Token | After successfully authenticating against our API you will get a JSON Web Token (JWT) as a response which is required for any following request. |
| Customer | The end user whose identity shall be verified. |
| Ident | An Ident is what we call the entity that you create via our API to represent the user in the verification process. Identify generates an internal IdentID that uniquely identifies an Ident. |
| IdentID | The IdentID is also being used by the user to start the verification process. |
Getting Started
Before you can use the requests, a proper environment has to be set up. An environment holds parameters for setting your partner name, API Key, TOKEN and the gateway host for your requests. The parameters in the API URL are placeholders. The applicable values for the placeholders are automatically used in your requests.
Identify API URL looks like this:
https://api.identify24.de/{method}
Content and Charset
Please make sure that all data is sent as UTF-8 encoded JSON. This is especially important because the encoding will influence the calculation of the security token. The expected JSON structure is flat.
Protocol and Port
To ensure that all parameters are encrypted, all requests to the Identify servers must be performed using HTTPS.
HTTP requests are not allowed.
The port for all requests is: 443.
API requests without authentication will also fail.
Lifetime
| Item | Description |
|---|---|
| JWT | The authentication token has an idle time of 30 minutes after which it expires. (New token can be requested after expire) |
| Ident | An Ident has a lifetime of 90 days if data retention policies do not dictate otherwise. |
Authentication
The JWT will be invalidated on the server side if it has not been used for at least 30 minutes. If you request our API with an expired token, your requests will get a 401 Unauthorized error and you have to authenticate again.
Errors
Identify uses conventional HTTP response codes to indicate the success or failure of an API request.
In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a request failed, etc.). Codes in the 5xx range indicate an error with server side.
| 200 - OK | Everything worked as expected. |
|---|---|
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 402 - Request Failed | The parameters were valid but the request failed. |
| 403 - Forbidden | The API key doesn't have permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 409 - Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). |
| 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Errors | Something went wrong on server side. (These are rare.) |
METHODS
auth
POST PARTNER AUTHENTICATION
https://api.identify24.de/auth
If the request was successful, you receive the response code: HTTP/1.1 200 OK. The response body contains a key / value pair for the JWT, with the key being:token
HEADERS
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
BODY raw
{
"PARTNER": "{{PARTNER}}",
"APIKEY": "{{APIKEY}}"
}
SAMPLE CURL REQUEST
curl --location --request POST "https://api.identify24.de/auth" --header "Content-Type: application/json" --data "{ \"PARTNER\":\"YOUR PARTNER USERNAME\", \"APIKEY\":\"YOUR API KEY\" }"
SAMPLE RESPONSE
{
"result": true,
"response_status": 200,
"token": "xxx",
"messages": [
"Successful.."
]
}
ident/create
POST CREATE NEW IDENTITY VERIFICATION REQUEST
https://api.identify24.de/ident/create
Creates new identity verification request.Returns status code 200 if successful.
The body of this response also contains a JSON-formatted key/value pair: {"ident_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
containing Identify's internal IdentID of this Ident.
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
BODY raw
{
"project_id" : "xxx",
"person_title" : "Optional",
"gender" : "MALE",
"person_first_name" : "John",
"person_last_name" : "Doe",
"person_position" : "Optional",
"email" : "johndoe@identify24.de",
"street" : "Markgrafenstr.",
"house_no" : "23",
"zip_code" : "94670",
"city" : "Nürnberg",
"country" : "DE",
"language" : "de",
"mobile_phone" : "01511111111",
"international_code" : "DE",
"birthday" : "1981-09-05",
"birth_place" : "BERLIN",
"nationality" : "DE",
"type_of_id" : "Personalausweis",
"id_number" : "LJFE8J32NDM",
"id_country" : "DE",
"id_issue_date" : "2021-05-10",
"id_end_date" : "2031-05-09",
"issuing_authority" : "Stadt Nürnberg",
"pdf_url" : "https://xxxxxxxxxx.pdf",
"pdf_content" : "data:@file/pdf;base64,xxxxxxxxxxxxxxxxx"
}
SAMPLE CURL REQUEST
curl -X POST \
https://api.identify24.de/ident/create \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
-d '{
"project_id" : "6",
"birthday" : "1981-09-05",
"birth_place" : "BERLIN",
"email" : "johndoe@identify24.de",
"gender" : "MALE",
"person_title" : "Dr.",
"person_first_name" : "John",
"person_last_name" : "Doe",
"person_position" : "Optional",
"mobile_phone" : "01511111111",
"nationality" : "DE",
"international_code" : "DE",
"street" : "Markgrafenstr.",
"house_no" : "23",
"zip_code" : "94670",
"city" : "Nürnberg",
"country" : "DE",
"language" : "de",
"type_of_id" : "Personalausweis",
"id_number" : "LJFE8J32NDM",
"id_country" : "DE",
"id_issue_date" : "2021-05-10",
"id_end_date" : "2031-05-09",
"issuing_authority" : "Stadt Nürnberg",
"pdf_content" : "data:@file/pdf;base64,xxxxxxxxxxxxxxxxx",
"custom_id" : "My ID for reference",
"custom1" : "custom field 1",
"custom2" : "custom field 2",
"custom3" : "custom field 3",
"custom4" : "custom field 4"
}'
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"ident_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"conference_url": "https://identify24.de/apply/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Ident Attributes
| Parameter | Required | Description |
|---|---|---|
| project_id | Yes | - |
| birthday | Yes | ISO 8601 format: YYYY-MM-DD |
| birth_place | No | The user's birthplace. All uppercase. |
| Yes | E-mail address of the user. | |
| gender | No | The user's gender. Either MALE or FEMALE. |
| person_title | No | Academic title. This will only be used, if the title is part of the name and shown in ID documents. |
| person_first_name | Yes | The user's first name(s). All uppercase. |
| person_last_name | Yes | The user's last name. All uppercase. |
| person_position | No | - |
| mobile_phone | Yes | Mobile phone number of the user. If no country code is provided, "0049" is assumed. |
| international_code | No | - |
| nationality | Yes | The user's nationality. Uppercase two-letter code as defied in ISO 3166. |
| street | Yes | The user's street. Will be provided in sub-object named address. All uppercase. |
| house_no | Yes | - |
| zip_code | Yes | The user's zip code. Will be provided in sub-object named address. |
| city | Yes | The user's city. Will be provided in sub-object named address. All uppercase. |
| country | Yes | The user's country. Uppercase two-letter code as defied in ISO 3166. Will be provided in sub-object named address. |
| language | No | The user's language for identification. Either of 'de', 'en', 'pl', 'cs'. 'sk'. Defaults to 'de' if unset or invalid. |
| type_of_id | No | The type of ID document which is used by the user. Possible values are: "Personalausweis" for ID card or "Reisepass" for passport. |
| id_number | No | The ID number of valid ID document. |
| id_country | No | The issuing country of the ID document. Uppercase two letter cod as defined in ISO 3166. |
| id_issue_date | No | The date when the ID document was issued in ISO 8601 format: YYYY-MM-DD |
| id_end_date | No | The date until the ID document is valid in ISO 8601 format: YYYY-MM-DD |
| issuing_authority | No | The government agency who issued the ID document. |
| pdf_url | No | URL of PDF file to be signed which should be fetched by identify. |
| pdf_content | No | Content of Base64 encoded PDF file to be signed. |
| custom_id | No | Custom ID field for use by partner. |
| custom1 | No | Custom field for use by partner. |
| custom2 | No | Custom field for use by partner. |
| custom3 | No | Custom field for use by partner. |
| custom4 | No | Custom field for use by partner. |
ident/setOnboardifyAppointment
POST UPDATE APPOINTMENT IDENTITY VERIFICATION REQUEST
https://api.identify24.de/ident/setOnboardifyAppointment
The generated ident is assigned an appointment date. If successful, it returns the status code 200 and the ID of the history record providing the appointment details.
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
BODY raw
{
"ident_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"termin_date" : "2024-06-30T15:20+01:00",
"termin_user" : "1",
}
SAMPLE CURL REQUEST
curl -X POST \
https://api.identify24.de/ident/setOnboardifyAppointment \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
-d '{
"ident_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"termin_date" : "2024-06-30T15:20+01:00",
"termin_user" : "1"
}'
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"insert_id": "xxxxxxx"
}
Ident Attributes
| Parameter | Required | Description |
|---|---|---|
| ident_id | Yes | ID information of the created ident |
| termin_date | Yes | ISO 8601 Format: YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00) |
| termin_user | Yes | ID of the representative who will conduct the interview |
ident/get
GET GET IDENTITY
https://api.identify24.de/ident/get/{ident_id}
Get an ident
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
SAMPLE CURL REQUEST
curl -X GET \
https://api.identify24.de/ident/get/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"data": {
"id": "ece4f137-31ea-11ee-849e-005056bb3f3f",
"project_id": "13",
"company_name": "Test Company",
"company_hrb_number": "",
"company_hrb_city": "",
"company_street": "",
"company_house_no": "",
"company_zip_code": "",
"company_city": "",
"company_country": "DE",
"person_title": "",
"gender": "",
"person_first_name": "Jane",
"person_last_name": "Doe",
"person_position": "",
"email": "jane.doe@identify24.de",
"street": "Parkstr",
"house_no": "45",
"postal_code": "90763",
"city": "Fürth",
"land": "DE",
"mobile_number": "+491747643106",
"phone_number": "456",
"id_type": "ghjhggh",
"nationality": "",
"id_issuing_authority": "DE",
"id_issue_date": "01-01-2021",
"id_expire_date": "17-06-2025",
"id_number": "45546456456",
"id_mrz": "",
"person_maiden_name": "",
"international_code": "DE",
"birthday": "1978-01-01",
"birth_place": "ghhghj",
"custom_id": "",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"status": "Successful",
"status_code": "5",
"created_at": "03-08-2023 12:45:56",
"appointment_date": "2023-08-03T15:00:00Z",
}
}
ident/getIdentData
GET GET IDENTIFICATION DATA
https://api.identify24.de/ident/getIdentData/{ident_id}
Get all data from ident
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
SAMPLE CURL REQUEST
curl -X GET \
https://api.identify24.de/ident/getIdentData/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"data": {
"ident": {
"customer_id": "29078",
"id": "e9b57479-644d-11ef-b4ac-005056bb3f3f",
"project_id": "274",
"company_name": "",
"company_hrb_number": "",
"company_hrb_city": "",
"company_street": "",
"company_house_no": "",
"company_zip_code": "",
"company_city": "",
"company_country": "DE",
"person_title": "",
"gender": "",
"person_first_name": "Sven",
"person_last_name": "Faerber",
"person_position": "Optional",
"email": "sven@3flows.com",
"street": "Markgrafenstr.",
"house_no": "23",
"postal_code": "51427",
"city": "Bergisch Gladbach",
"land": "DE",
"mobile_number": "017624751749",
"phone_number": "",
"id_type": "Personalausweis",
"nationality": "",
"id_issuing_authority": "DE",
"id_issue_date": "10-05-2021",
"id_expire_date": "09-05-2031",
"id_number": "LJFE8J32NDM",
"id_mrz": "",
"person_maiden_name": "",
"international_code": "DE",
"birthday": "1973-12-17",
"birth_place": "BERLIN",
"custom_id": "My custom ID",
"custom1": "custom1",
"custom2": "custom2",
"custom3": "custom3",
"custom4": "custom4",
"status": "Successful",
"status_code": "5",
"created_at": "13-09-2024 10:25:26",
"appointment_date": "2024-11-11 11:11"
},
"identification_pdf": {
"file_name": "identification_pdf",
"download_url": "https://api.identify24.de/download/xxx/identification.pdf",
"file_date": "21-02-2024 11:10:25",
"file_size": "1.42 MB",
"file_hash": "ad00dc69f4f145342e74baccb9986987566849b8bd213b5920a8f2a238006e37"
},
"signed_pdf": {
"file_name": "signed.pdf",
"download_url": "https://api.identify24.de/download/xxx/signed.pdf",
"file_date": "21-02-2024 11:13:13",
"file_size": "2.34 MB",
"file_hash": "ad00dc69f4f145342e74baccb9986987566849b8bd213b5920a8f2a238006e37"
},
"recordings": [
{
"file_name": "65e5a013502a2.webm",
"download_url": "https://api.identify24.de/download/xxx/65e5a013502a2.webm",
"file_date": "13-09-2024 10:28:59",
"file_size": "12.27 MB"
}
],
"screenshots": [
{
"file_name": "28804.png",
"download_link": "https://api.identify24.de/download/29078/28804.png",
"file_date": "13-09-2024 10:28:18",
"file_size": "0.31 MB"
},
{
"file_name": "54071.png",
"download_link": "https://api.identify24.de/download/29078/54071.png",
"file_date": "13-09-2024 10:28:20",
"file_size": "0.3 MB"
}
]
}
}
project/getAll
GET GET ALL PROJECTS
https://api.identify24.de/project/getAll
Retrieves all projects
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
SAMPLE CURL REQUEST
curl -X GET \
https://api.identify24.de/project/getAll \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
-H 'cache-control: no-cache'
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"data": [
{
"id": "6",
"title": "911 Internet GmbH",
"status": "Active"
}
],
"response_status": 200
}
project/get
GET GET PROJECT
https://api.identify24.de/project/get
Retrieves an ident
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
BODY raw
{
"project_id" : xxx
}
SAMPLE CURL REQUEST
curl -X GET \
https://api.identify24.de/project/get \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
-d '{
"project_id" : 6
}'
SAMPLE RESPONSE
{
"result": true,
"messages": [],
"data": {
"id": "6",
"title": "911 Internet GmbH",
"status": "Active"
},
"response_status": 200
}
webhook/getAll
GET GET ALL WEBHOOKS
https://api.identify24.de/webhook/getAll
Retrieves all partner webhooks
HEADERS
X-API-PARTNER
application/json
(REQUIRED) Partner User Name
(REQUIRED) Partner User Name
X-API-TOKEN
application/json
(REQUIRED) Your private Auth Token
(REQUIRED) Your private Auth Token
Content-Type
application/json
(REQUIRED) The media type
(REQUIRED) The media type
SAMPLE CURL REQUEST
curl -X GET \
https://api.identify24.de/webhook/getAll \
-H 'Accept: */*' \
-H 'Content-Type: application/json' \
-H 'X-API-PARTNER: 911-internet' \
-H 'X-API-TOKEN: xxx' \
-H 'cache-control: no-cache'
SAMPLE RESPONSE
{
"result": true,
"response_status": 200,
"messages": [],
"data": [
{
"id": "1",
"status": "4",
"url": "https://xxxxxx.xxx",
"created_at": "2020-06-21 11:03:49",
"updated_at": "2024-03-06 17:54:32"
},
{
"id": "2",
"status": "4",
"url": "https://yyyyyy.yyy",
"created_at": "2020-06-21 11:03:49",
"updated_at": "2024-03-06 17:54:32"
}
]
}
Webhook
What is a Webhook ?
A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. Unlike typical APIs where you would need to poll for data very frequently in order to get it real-time. This makes webhooks much more efficient for both provider and consumer. The only drawback to webhooks is the difficulty of initially setting them up.
Webhooks are sometimes referred to as “Reverse APIs,” as they give you what amounts to an API spec, and you must design an API for the webhook to use. The webhook will make an HTTP request to your app (typically a POST), and you will then be charged with interpreting it.
Before using webhook service you must define a webhook url from your partner portal.
On some situations, you will have to make some security adjustments on your server side reciever endpoint for acquiring these requests correctly. For further necessary support please contact with us.
How to define webhook URL ?
You can define a webhook reciever URL from the partner portal > merchant details section.
Sample Payload
Identify will send these payloads via POST method.
SAMPLE WEBHOOK PAYLOAD
{
"ident_id": "xxxxx",
"status": "xxxxx",
"status_code": "xxxxx",
"project_id": "xxxxx",
"custom_id": "xxxxx",
"company_name": "xxxxx",
"first_name": "xxxxx",
"last_name": "xxxxx",
"custom1": "xxxxx",
"custom2": "xxxxx",
"custom3": "xxxxx",
"custom4": "xxxxx",
}
Webhook Statuses
Identify uses different statuses to monitor the progress of webhooks.
| 1 - PENDING | Webhook is pending to be processed. |
|---|---|
| 2 - RUNNING | Webhook is currently being processed. |
| 3 - SUCCESS | Webhook completed successfully. |
| 4 - FAILED | Webhook failed. |