Identification service
Introduction

This is GoPay 3G REST API for identification service. All communication with API is encoded in UTF-8.

There are several endpoints you will communicate with:

  • Authorization service - Provides authorization functions you need to get access (e.g. to the Identification service).

  • Identification service - Provides functions you use for obtaining identification statuses of persons.

API ENDPOINT
API endpoint - https://api.gopay.com
Authorization service

Authorization service allows the authorization of operations done via API GoPay. OAuth 2.0 is used for connection.

Authorization service uses several types of different authorization tokens. Each type of authorization token has a defined set of operations which it is intended for.

Application token

Application token is created based on the transmitted access data in <ClientID>:<ClientSecret> form. Token is forwarded as an authorization parameter in the header of HTTP request via Authorization: Bearer <accessToken>. Standard OAuth 2.0 is used for connection, specifically Client credentials.

If you do not have a ClientID and ClientSecret, please, make your registration.

REQUEST

GET /v1/auth/login/app

HEADER OF THE REQUEST

Parameter’s name Parameter’s description Required
Authorization HTTP authorization which is set as <ClientID>:<ClientSecret> YES

RESPONSE

Parameter’s name Parameter’s description Required
accessToken Access token YES
curl
Request

curl -v -N https://api.gopay.com/v1/auth/login/app \
-X "GET" \
-u "<ClientID>:<ClientSecret>"


Response

{
    "accessToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJodHRwOi8vYXV0aC9hcHAvMSIsImlzcyI6ImdvcGF5LmNvbSIsInNjb3B"
}
Client token

After connection the identification subscriber is able to read the identification data of the Client. The client token also represents the consent of forwarding identification data to the identification subscriber. Standard OAuth 2.0 is used for connection, specifically Authorization Code.

Please visit our help center for more information.

Process of user profile connection

The goal of connecting the user profile is to get client (Consent) token which will be used by the identification subscriber for sending request to identification services.

1) Redirecting Client to authorization service

The Identification subscriber will redirect the Client to authorization service to get the authorization (code). By the GET parameters Identification subscriber is sending as GET parameters:

Parameter’s name Parameter’s description Required
scopes perm.client.identification (scope of access) YES
client_id Merchant’s client identifier YES
state Pairing identifier (is set as query parameter redirect_url) NO
redirect_uri URL address where Client will be redirected to after client consents NO
prefill_id Result ID of prefill function NO
curl
curl -v "https://auth.gopay.com/consent?scopes[]=perm.client.identification:read&state=customer123&client_id=777777777777&redirect_uri=https%3A%2F%2Fcallback.odberatel-identity.cz&prefill_id=GhUhElzTqPmA5tUVJzO74SeMFt0Y3NEhpvQhbu5sTI8COWYqJFrdki" \
-X "GET"
2) Redirecting Client to Identity subscriber's URL

The Client will give a consent after registration or login. Afterwards he will be redirected back to Identification subscriber’s redirect_uri with the required authorization (code) in order to obtain the client token.

In the case of unexpected processing there is an error parameter returned with a specific reason.

In redirect we forward GET parameters:

Parameter’s name Parameter’s description
code Authorization code for getting the access token, expires in 10 minutes
state Pairing identifier
error Unexpected error in processing
curl
curl -v "https://callback.identification-subscriber.com/?code=pgCNnZnVSNTT&state=customer123" \
-X "GET"
3) Getting the Client token

Based on the authorization (code) the Identification subscriber will call for client access token. Refreshing of the Client token is required for obtaining new access token.

Returned parameter (access token) allows Identification subscriber to make API calls to Identification service, e.g. read identification data of the Client.

In case of Client’s identification data changes the HTTP notification about status change is sent. Please visit our help center for more information.

REQUEST

POST /v1/auth/token

BODY OF REQUEST

Parameter’s name Parameter’s description Required
code Authorization code YES
client_id client_credentials YES
client_secret client_credentials YES
grant_type Type of request YES

RESPONSE

Parameter’s name Parameter’s description Data’s type
accessToken Access token, active for 1 hour string
refreshToken Serves for getting new accessToken string
clientProfileId Identifier of client profile integer
curl
Request

curl -v https://api.gopay.com/v1/auth/token \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbA&grant_type=authorization_code&code=pgCNnZnVSNTT"


Response

{"refreshToken":
    "eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5
    Nzc1MDc3NS1lODdmLTQyNzgtOTdlNC1iY2IxNzJjZDNhMzMiLCJpc3MiOiJnb3BheS5jb20i
    LCJqdGkiOiItNTY1MDU5NzQ0ODI1NDgzODAzIn0.MmJf0ZYgM9KBEWjnNeml_GKGmj3pctjt
    ufWwe-685N0oecux48nTq5SuRqfTfpflLUN76XwW4XVXiDYupG2xGgJiFk5KgemOzaIrM01I
    lcOBoDxQFXxH96rKgODIhZ0Y1CpIspQMFwBgdEksC-mlumQM5quJd8i8Hj31yg2nA1I0IOhW
    PAUg0dRg4tEUn_V1JFM3_qlU5mFzFZTWLOuV5bF4CRxxbTx2RGbU9HExHmmRVBzpze-XISmc
    wLR4uzxRs9YgPzpzE3ZXudXv3SUpdNn0X-i-lApfBWJ9k0jm2bfdO77tTi4_JwgdoBEj3RMy
    XD1UxvylAI2zNQrFg7GTsA",
"accessToken":
    "eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJo
    dHRwOi8vYXV0aC9hcHAvMzI3IiwiaXNzIjoiZ29wYXkuY29tIiwic2NvcGVzIjpbInBlcm0u
    Y2xpZW50LmlkZW50aWZpY2F0aW9uIiwiaHR0cDovL2NsaWVudC9jbGllbnRwcm9maWxlLzU4
    MSJdLCJleHAiOjE1MTM1OTcwOTgsImp0aSI6Ijg5MTc0NzE1Mjc3Nzk1MjczNDkifQ.QKKKC
    9EkxWS-7yi2LiRwELruziDlulOOAEAdAfxIPHSaubqllLVTFnCHf-Dm4bCkHhv-t7e9sJemt
    6AED4BH1fRg8s3_p0sahEd362O-gt0NyTTkPfnmmvUcbk2EfuFLZAoQqeni4NWgHTJWKWc9H
    NyFgAkyEbhopJ8mc5wP3o1AjiArHuLZmFaB9Cu6FWB64w5hkpTzx_YzpjVU1YxypF-8rPFRn
    X4duHSPXRhr7WmM-NjFwsYxBvuqNkagzENsvveJs3CnNIryZ0tlSgxiSEpCQeHRIJigHWpoG
    Vg_cy2f-pN-nU1OLdPHNh8Ycb_xRvjA5CXC8mhXamo95F4dpg",
"clientProfileId": 123
}
Refresh

Client token has a timeout of 60 minutes. In order to obtain a new access token it is necessary to:

Refresh token is required to hold session on the Client. It is necessary to ensure its safe storage. To reduce the possibility of a leak we generate a new Refresh token with every refresh.

REQUEST

POST /v1/auth/token

BODY OF REQUEST

Parameter’s name Parameter’s description Data’s type
client_id client_credentials integer
client_secret client_credentials string
grant_type Type of request string
refresh_token Refresh token string

RESPONSE

Parameter’s name Parameter’s description Data’s type
accessToken Access token, active for 1 hour string
refreshToken Serves for getting the new accessToken. CAUTION - Refresh token is changed with every single calling of refresh function. string
clientProfileId Identifier of client profile integer
curl
Request

curl -v -N https://api.gopay.com/v1/auth/token \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbAb&grant_type=refresh_token&refresh_token=eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5"

Response

{"refreshToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJh
    ZmExNTc3NS0zYzcwLTQxYzctYWYwMS0wNDFlMGNmZjc4ZmUiLCJpc3MiOiJnb3BheS5jb20i
    LCJqdGkiOiItNjMzNzM5NzQyMjM1NTcyNjc0MyJ9.CNE4Za3mtBntw-imqCsctqyqXHikJxI
    rVrFArqc929Aikeg-zTipJ3vFgd2xwvJHvW3aIM2xagCNWH76RROC40CUTkI8SSQPNAD33sl
    dTBS3pf45BtCXUqSn9R_XOfWbMoi7A9mWxFoCNVGj4s9Z9A3oo2nbw68WCr0lrWrbSUZDxmy
    s-9Nbq2OgkILJweNj2kNSLIalcxqhbA-dv_-s7XSm6XNk82sY7DVkD5f5FMckwje_YwLP3aw
    dXP-y5aEEZvN3CBO_NpohCXbFkKevSAoBqlVaQPhwo4TIVt9eHrK_FX-ep3QYNNIuFM2YhcP
    XMBKqtO0oKYOXc4bHyx_PbQ",
"accessToken":"eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJo
    dHRwOi8vYXV0aC9hcHAvMzI3IiwiaXNzIjoiZ29wYXkuY29tIiwic2NvcGVzIjpbInBlcm0u
    Y2xpZW50LmlkZW50aWZpY2F0aW9uIiwiaHR0cDovL2NsaWVudC9jbGllbnRwcm9maWxlLzU4
    MSJdLCJleHAiOjE1MTM1OTgzMjksImp0aSI6Ii02MTI4MTc0ODcwNTUyMTYwNDk4In0.TKNf
    3YtCn9scQhFry2hfYavgsT3nyeJ4l6Am8Fm0CWI147UGRCWHuWZcEu6SqdFCxu1mlyOXLZl_
    gs4UhynW3UjDkCTE2rSkMEK3Lbcp7122okLYA1JZr1ZPAt2RQhrlnfsPOuBGZcDDnmtdqJwc
    v481jvBzKywfgHknM9__ZVl5H3CeE6We0woxSxOg9swFtBXrUEZRZU53OOJ7XEUmOHxtPNsn
    cSV0rY-tX79Xyf3192GaGoN5xVMcLkYXIVs4QT0dUa1n16J6kvJ_JhggniBeNXjIleGEcVKK
    N0soCwQqTSb2TNVt66oqZhYcR55sDxMiMZU0nrs1v8KPEpiVfg",
"clientProfileId": 123
}
Revocation

By revocation of token Identification subscriber will disconnect from identification profile.

REQUEST

POST /v1/auth/revoke

BODY OF REQUEST

Parameter’s name Parameter’s description Data’s type
client_id client_credentials integer
client_secret client_credentials string
token Refresh token string

RESPONSE

Parameter’s name HTTP Parameter’s description
{Empty response} 200 Revocation was successfull
{Empty response} 401 Used wrong client_id or client_secret
{Empty response} 404 Token does not exist
{Empty response} 409 Request does not contain authorization token
curl
Request

curl -v -N https://api.gopay.com/v1/auth/revoke \
-X "POST" \
-d "client_id=777777777777&client_secret=AbAbAbAbAbAb&token=eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5"

Response

Http 200
Identification service

As a part of the identification service by GoPay we offer identification of the user without his physical presence.

Identification service is a complex processing comparison of all input information and materials provided by the user for example: comparing photos of documents or facematching, validation of account owner or disponent (husband/wife), comparison of manually inserted IP address and GEO localization and other internal control procedures, developed specifically for this service in order to ensure a higher quality of output data beyond legislative requirements.

Identification status

Allows to read identification data of the Client, eventually actual state of the identification.

Parameter clientProfileId is obtained from response of getting client token.

In case of Client’s identification data changes the HTTP notification about status change is sent. Please visit our help center for more information.

REQUEST

GET /v1/client/client-profile/{clientProfileId}/identification-status
Parameter’s name Parameter’s description Required Data’s type
clientProfileId ID of client profile YES path, string

HEADER OF REQUEST

Parameter’s name Parameter’s description Required
Authorization Bearer Client <access-token> YES

RESPONSE

Parameter’s name Parameter’s description Data’s type
clientProfileId Identifier of client profile integer
state Identification status of client profile string
reasons List of reasons why the process failed or not yet finished string
dateStarted Date when the identification process started string, yyyy-mm-dd HH:MM:SS:MS
dateLastChange Date of the last activity within identification process string, yyyy-mm-dd HH:MM:SS:MS HH:MM:SS:MS
subjectType Legal type of identification subject string
subjectData Aggregates known information about the client object
identificationData Contains all of the collected identification data object
curl
Request

curl -v -N https://api.gopay.com/v1/client/client-profile/123/identification-status \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ"

Response

{
    "clientProfileId": 123,
    "state": "NOT_IDENTIFIED",
    "reasons": [
        "DENIED_FACEMATCH"
    ],
    "dateStarted": "2018-07-19 10:00:02.423",
    "dateLastChange": "2018-07-22 10:00:02.423"
}
Client data prefill

If Identification subscriber requires to add/change identification data, Client is redirected to GoPay Identification service to add the identification data.

The Client will login to his profile, where he can make necessary changes.

URL for redirection: https://client.gopay.com/identification

PDF

Allows to generate PDF file of client identification.

Parameter clientProfileId is obtained from response of identification status / getting client token response.

REQUEST

GET /v1/client/client-profile/{clientProfileId}/identification-pdf
Parameter’s name Parameter’s description Required Data’s type
clientProfileId Id of client profile YES path, string
onDate Generating PDF file to specify date (if not specify, actually state is returned) NO query, YYYY-MM-DD

In the header of a request you can use Client or Application token (if the consent was successfully given by the client).

HEADER OF REQUEST

Parameter’s name Parameter’s description Required
Authorization Bearer access-token yes

RESPONSE

Response type application/pdf.

curl
Request

curl -v - N https://api.gopay.com/v1/client/client-profile/123/identification-pdf?onDate=2018-12-31 \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ"

Response

Response type application/pdf.

Advanced features

Additional functionalities use the same communication with payment gateway as standard implementation, but extend it by new options.

Prefill

This serves for prefilling Client data for future registraion/identification.

REQUEST

POST /v1/client/prefill-client-data

HEADER OF REQUEST

Parameter’s name Parameter’s description Required
Content-Type application/json YES
Authorization Bearer Application <access-token> YES

BODY OF REQUEST

Parameter’s name Parameter’s description Data’s type
firstName First name string
lastName Last name string
email Valid e-mail address string
phoneNumber Phone number with country code string
domesticBankAccount Domestic form of bank account string
internationalBankAccount IBAN object
address Address string

RESPONSE

Parameter’s name Parameter’s description Data’s type
prefillId ID of completed operation string
curl
Request

curl -v - N https://api.gopay.com/v1/client/prefill-client-data \
-X "POST" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJraWQiOiJkZWZhdWx0IiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ" \
-d '{
        "firstName":"Jaroslav",
        "lastName":"Novák",
        "email":"jaroslav@novak.com",
        "phoneNumber":"+420777111222",
        "address":"Pekárenská 12, 37001 České Budějovice",
        "domesticBankAccount":"1108398027/3030",
        "internationalBankAccount": {
          "iban":"CZ6508000000192000145399",
          "bic":"KOMBCZPP"
          }
    }'   
    
Response

{
    "prefillId": "GhUhElzTqPmA5tUVJzO74SeMFt0Y3NEhpvQhbu5sTI8COWYqJFrdki"
}
Objects

Description of each object used within the communication with the service.

internationalBankAccount

International form of bank account

Parameter’s name Parameter’s description Data’s type
iban IBAN string
bic SWIFT string
json
 {
   "iban":"CZ6508000000192000145399",
   "bic":"KOMBCZPP"
 }
subjectData

Aggregates known information about the client

Parameter’s name Parameter’s description Data’s type
firstName First name string
lastName Last name string
dateOfBirth Date of birth string, yyyy-mm-dd
birthNumber Birth number string
sex Sex string
nationality Country code string
json
{
    "firstName": "Pavel",
    "lastName": "Novák",
    "dateOfBirth": "1990-06-12",
    "birthNumber": "900612/0001",
    "sex": "MALE",
    "nationality": "CZE"
 }
identificationData

Contains all of the collected identification data

Parameter’s name Parameter’s description Data’s type
person Represents person who is being identified object
bankAccount Represents bank account verification object
address Represents address verification object
additionalDocument Additional documents object
json
{
    "persons": [
      {
        "firstName": "Pavel",
        "lastName": "Novák",
        "dateOfBirth": "1990-06-12",
        "birthNumber": "900612/0001",
        "sex": "MALE",
        "country": "CZE",
        "faceMatch": {
          "verified": true,
          "source": "UPLOAD",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760",
        },
        "identDocuments": [
          {
            "documentNumber": 123456,
            "state": "VERIFIED",
            "source": "UPLOAD",
            "documentType": "ID_CARD",
            "expiryDate": "2018-02-15 17:10:44.760",
            "nationalCountry": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "bankAccounts": [
          {
            "state": "VERIFIED",
            "country": "CZE",
            "prefix": {},
            "accountNumber": 2174251001,
            "bankCode": 192,
            "iban": "CZ6003000000002174251001",
            "bic": "CEKOCZPP",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "addresses": [
          {
            "state": "VERIFIED",
            "street": "Vinohradská",
            "streetNumber": 22,
            "postalCode": 11000,
            "city": "Praha",
            "country": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "additionalDocuments": [
          {
            "documentType": "BANK_STATEMENT",
            "source": "UPLOAD",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ]
      }
    ],
    "bankAccounts": [
      {
        "state": "VERIFIED",
        "country": "CZE",
        "prefix": {},
        "accountNumber": 2174251001,
        "bankCode": 192,
        "iban": "CZ6003000000002174251001",
        "bic": "CEKOCZPP",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ],
    "addresses": [
      {
        "state": "VERIFIED",
        "street": "Vinohradská",
        "streetNumber": 22,
        "postalCode": 11000,
        "city": "Praha",
        "country": "CZE",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ],
    "additionalDocuments": [
      {
        "documentType": "BANK_STATEMENT",
        "source": "UPLOAD",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
    ]
  }
person

Represents person who is being identified

Parameter’s name Parameter’s description Data’s type
firstName First name string
lastName Last name string
dateOfBirth Date of birth string, yyyy-mm-dd
birthNumber Birth number string
sex Sex string
nationality Country code string
faceMatch Represents face verification of the person object
identDocument Represents main identification document object
bankAccount Represents bank account verification object
address Represents address verification object
additionalDocument Additional documents object
json
 [{
        "firstName": "Pavel",
        "lastName": "Novák",
        "dateOfBirth": "1990-06-12",
        "birthNumber": "900612/0001",
        "sex": "MALE",
        "nationality": "CZE",
        "faceMatch": {
          "verified": true,
          "source": "UPLOAD",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760"
        },
        "identDocuments": [
          {
            "documentNumber": 123456,
            "state": "VERIFIED",
            "source": "UPLOAD",
            "documentType": "ID_CARD",
            "expiryDate": "2018-02-15 17:10:44.760",
            "nationalCountry": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "bankAccounts": [
          {
            "state": "VERIFIED",
            "country": "CZE",
            "prefix": {},
            "accountNumber": 2174251001,
            "bankCode": 192,
            "iban": "CZ6003000000002174251001",
            "bic": "CEKOCZPP",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "addresses": [
          {
            "state": "VERIFIED",
            "street": "Vinohradská",
            "streetNumber": 22,
            "postalCode": 11000,
            "city": "Praha",
            "country": "CZE",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ],
        "additionalDocuments": [
          {
            "documentType": "BANK_STATEMENT",
            "source": "UPLOAD",
            "ip": "77.75.77.39",
            "dateReceived": "2018-02-15 17:10:44.760",
            "dateVerified": "2018-02-17 10:10:45.860"
          }
        ]
  }]
faceMatch

Represents face verification of the person

Parameter’s name Parameter’s description Data’s type
verified Holds whether the face verification was successfull boolean
source Specifies the way of how the face image was provided string
ip IP address string
dateReceived Date when the face image was acquired string, yyyy-mm-dd HH:MM:SS:MS
json
{
      "verified": true,
      "source": "UPLOAD",
      "ip": "77.75.77.39",
      "dateReceived": "2018-02-15 17:10:44.760"
  }
identDocument

Represents main identification document

Parameter’s name Parameter’s description Data’s type
documentNumber Official identifier of identification document string
state State of document verification string
source Specifies the way of how was the document provided string
documentType Type of uploaded document string
expiryDate Date of document’s expiration string, yyyy-mm-dd HH:MM:SS:MS
nationalCountry Country code string
ip IP address string
dateReceived Date when the document was acquired string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Date when the document was verified string, yyyy-mm-dd HH:MM:SS:MS
json
[
        {
          "documentNumber": 123456,
          "state": "VERIFIED",
          "source": "UPLOAD",
          "documentType": "ID_CARD",
          "expiryDate": "2018-02-15 17:10:44.760",
          "nationalCountry": "CZE",
          "ip": "77.75.77.39",
          "dateReceived": "2018-02-15 17:10:44.760",
          "dateVerified": "2018-02-17 10:10:45.860"
        }
  ]
bankAccount

Represents bank account verification

Parameter’s name Parameter’s description Data’s type
state Verification status of bank account string
country Country code string
prefix Prefix of bank account number string
accountNumber Number of client’s bank account string
bankCode Client’s bank code string
iban Client’s IBAN string
bic Client’s SWIFT string
ip IP address string
dateReceived Date when the bank account was acquired string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Date when the bank account was verified string, yyyy-mm-dd HH:MM:SS:MS
json
[
        {
             "state": "VERIFIED",
             "country": "CZE",
             "prefix": {},
             "accountNumber": 2174251001,
             "bankCode": 192,
             "iban": "CZ6003000000002174251001",
             "bic": "CEKOCZPP",
             "ip": "77.75.77.39",
             "dateReceived": "2018-02-15 17:10:44.760",
             "dateVerified": "2018-02-17 10:10:45.860"
        }
  ]
address

Represents address verification

Parameter’s name Parameter’s description Data’s type
state State of address verification string
street Street string
streetNumber Street number string
postalCode Postal code string
city Město City
country Country code string
ip IP address string
dateReceived Date when the address was acquired string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Date when the address was verified string, yyyy-mm-dd HH:MM:SS:MS
json
[
      {
        "state": "VERIFIED",
        "street": "Vinohradská",
        "streetNumber": 22,
        "postalCode": 11000,
        "city": "Praha",
        "country": "CZE",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
]
additionalDocument

Additional documents

Parameter’s name Parameter’s description Data’s type
documentType Type of additional document string
source Specifies the way of how was the document provided string
ip IP address string
dateReceived Date when the additional document was acquired string, yyyy-mm-dd HH:MM:SS:MS
dateVerified Date when the additional document was verified string, yyyy-mm-dd HH:MM:SS:MS
json
[
      {
        "documentType": "BANK_STATEMENT",
        "source": "UPLOAD",
        "ip": "77.75.77.39",
        "dateReceived": "2018-02-15 17:10:44.760",
        "dateVerified": "2018-02-17 10:10:45.860"
      }
]
Code lists
error

Error while redirecting Client to Identity subscriber’s URL

Parameter’s name Parameter’s description
access_denied The Client did not give a consent
invalid_scope Unauthorized access
state

Identification status of client’s profile

Parameter’s name Parameter’s description
PENDING Identification process in progress
IDENTIFIED Identification completed
PARTIALLY_IDENTIFIED Identification partially completed
NOT_IDENTIFIED Identification was not performed
reasons

List of reasons why the process has failed or not finished yet

Parameter’s name Parameter’s description
EXPIRED_IDENTIFICATION Expired identification
EXPIRED_IDENT_DOCUMENT Expired identification’s document
WAITING_IDENT_DOCUMENT Waiting for identification’s document
WAITING_ADDITIONAL_DOCUMENT Waiting for additional document
WAITING_ADDRESS Waiting for address verification
WAITING_BANK_ACCOUNT Waiting for bank account verification
DENIED_FRAUD Denied - false document
DENIED_FACEMATCH Denied - disagreement of facematch process
DENIED_BAD_QUALITY_DOCUMENT Denied - bad quality of document
subjectType

Legal type of identification subject

Parameter’s name Parameter’s description
PERSON Person
COMPANY Company
sex

Sex

Parameter’s name Parameter’s description
MALE Male
FEMALE Female
source

Specifies the way of how the face image was provided

Parameter’s name Parameter’s description
UPLOAD File’s upload
WEBCAM Webcam
MOBILE Mobile phone
Document state

State of uploaded document

Parameter’s name Parameter’s description
VERIFIED Valid
EXPIRED Expired
documentType

Type of uploaded document

Parameter’s name Parameter’s description
ID_CARD ID card
DRIVING_LICENSE Driving license
PASSPORT Passport
VISA Visa
UNSUPPORTED Unsupported document
UTILITY_BILL Utility bill
BANK_STATEMENT Bank statement
Verification status of bank account

Verification status of bank account

Parameter’s name Parameter’s description
VERIFIED Verified
Verification status of address

Verification status of address

Parameter’s name Parameter’s description
VERIFIED Verified
HTTP result codes
200 Http 200

Calling was successful

403 Http 403

Not-authorized access

409 Http 409

Validation errors

500 Http 500

Calling ended with error

404 Http 404

Service does not exist

Changelog

4/2019

23/4/2019 - Revocation - error result states added.

10/4/2019 - API endpoints unification, see Introduction.

12/2018

10/12/2018 - Redirecting Client to Identity subscriber’s URL - error states added, see the code list error.