API

This documentation explains the server API and how to handle completed verifications.
General
You can retrieve a customer authentication using its unique key. Once you've set up a webhook, you will receive a POST with those keys as they're created. You can also use the authentication response API to retrieve information from your dashboard into your own backend. You can't use this API on the Starter plan. This API will help you to access information about the status of verified users, etc.
1. API Explorer
We offer a swagger UI explorer, which allows you to test the endpoints of the API on your actual dashboard data. Please log into your dashboard and navigate to your integration page.
In the Advanced Parameters section, you'll find a link to the API Explorer. 
We can't link the API Explorer. You need to navigate to it yourself, using your real secret key to query your dashboard's data.
2. Endpoints
Below is a list of all our available API endpoints. Set up a webhook to get notified about finished verifications. Then, you can use the endpoints below to either query all verifications or the status of a certain verification via the authentication_key.
get
List completed authentications
https://app.passbase.com /api/v1/authentications/by_key/{{uuid:key}} 
Retrieves a list of completed authentications for the owner of the API key
Request
Response
Request
Headers
Content-Type
required
string
application/json
Authorization
required
string
APIKEY {{secret_api_key}}
Query Parameters
api_key
required
string
Your private API key which can be found in your developer dashboard's settings
from_created_at
optional
integer
Unix timestamp initial creation date
to_created_at
optional
integer
Unix timestamp final creation date
limit
optional
integer
Ma result length
offset
optional
integer
Specifies the items to skip when returning the result list
Response
200: OK
{
  "authentications": [
    {
      "key": "string",
      "authenticated": true,
      "authenticated_at": "2019-12-12",
      "reviewed_at": "2019-12-12",
      "review_status": true,
      "authentication_assessments": {
        "facematch": {
          "value": 0
        },
        "liveness": {
          "value": 0
        },
        "id_authenticity": {
          "value": 0
        },
        "overall": {
          "value": 0
        }
      },
      "end_user": {
        "customer_user_id": "string"
      },
      "authentication_document": "NATIONAL_ID_CARD",
      "documents": [
        {
          "document_type": "NATIONAL_ID_CARD",
          "document_information": [
            {
              "key": "DOCUMENT_NUMBER",
              "value": "string"
            }
          ]
        }
      ],
      "created_at": "2019-12-12",
      "updated_at": "2019-12-12"
    }
  ],
  "number_of_authentications": 0
}
401: Unauthorized
Invalid Credentials
​
get
Authentication by key
https://app.passbase.com /api/v1/authentications/by_key/{authentication_key}
GET /authentications endpoint to retrieve a list of authentication by key.
Request
Response
Request
Headers
Content-Type
required
string
application/json
Authorization
required
string
APIKEY{{secret_api_key}}
Query Parameters
api_key
required
string
Your private API key which can be found in your developer dashboard's settings
authentication_key
required
string
Authentication unique key. You will receive via webhook ro can query at /authentications
Response
200: OK
{
  "authentication": {
    "key": "string",
    "authenticated": true,
    "authenticated_at": "2019-12-12",
    "reviewed_at": "2019-12-12",
    "review_status": true,
    "authentication_assessments": {
      "facematch": {
        "value": 0
      },
      "liveness": {
        "value": 0
      },
      "id_authenticity": {
        "value": 0
      },
      "overall": {
        "value": 0
      }
    },
    "end_user": {
      "customer_user_id": "string"
    },
    "authentication_document": "NATIONAL_ID_CARD",
    "documents": [
      {
        "document_type": "NATIONAL_ID_CARD",
        "document_information": [
          {
            "key": "DOCUMENT_NUMBER",
            "value": "string"
          }
        ]
      }
    ],
    "created_at": "2019-12-12",
    "updated_at": "2019-12-12"
  },
  "status": "success",
  "code": 200
}
400: Bad Request
Your request is invalid
​
401: Unauthorized
Your API key is wrong
​
404: Not Found
Authentication not found
​
​
get
Authentication by customer id
https://app.passbase.com /api/v1/authentications/by_customer_user_id/{customer_user_id}
Returns a list of authentications from a given user
Request
Response
Request
Headers
Content-Type
required
string
application/json
Authorization
required
string
APIKEY{{secret_api_key}}
Query Parameters
api_key
required
string
Your private API key which can be found in your developer dashboard's settings
customer_uuser_id
required
string
The customer user id of the verification you want to retrieve
Response
200: OK
{
  "authentication": {
    "key": "string",
    "authenticated": true,
    "authenticated_at": "2019-12-12",
    "reviewed_at": "2019-12-12",
    "review_status": true,
    "authentication_assessments": {
      "facematch": {
        "value": 0
      },
      "liveness": {
        "value": 0
      },
      "id_authenticity": {
        "value": 0
      },
      "overall": {
        "value": 0
      }
    },
    "end_user": {
      "customer_user_id": "string"
    },
    "authentication_document": "NATIONAL_ID_CARD",
    "documents": [
      {
        "document_type": "NATIONAL_ID_CARD",
        "document_information": [
          {
            "key": "DOCUMENT_NUMBER",
            "value": "string"
          }
        ]
      }
    ],
    "created_at": "2019-12-12",
    "updated_at": "2019-12-12"
  },
  "status": "success",
  "code": 200
}
400: Bad Request
Your request is invalid
​
401: Unauthorized
Your API key is wrong
​
404: Not Found
Authentication not found
​
​
Server - Previous
Webhook
Next - Server
Errors
Last updated 1 month ago
API

General

1. API Explorer

2. Endpoints

getList completed authentications

getAuthentication by key

getAuthentication by customer id

get
List completed authentications

get
Authentication by key

get
Authentication by customer id
