DocumentationAPI Reference
DocumentationAPI Reference

Serialization

Kebab case

The Persona API accepts requests with member names using camelCase, kebab-case, and snake_case.

All responses use kebab-case for member names by default. However, you can override how member names are formatted by providing an additional Key-Inflection: <inflection> header to the request. The Persona API currently accepts kebab, camel, and snake for inflecting keys.

Data

Requests and responses follow the JSON API specification, using JSON-encoded bodies. List, fetch, and action endpoints do not require the request to contain a body. Responses contain a single JSON-encoded object with the following keys:

Key name

Value

data

A full serialization of the affected resource, as defined by the endpoint.

included

Full serializations of resources related to the affected resource.

meta

Other information not in the affected model's attributes, usually specific to the action being performed.

📘

Accessing PII via the API

Due to data privacy requirements and the sensitivity of the data, we do not expose the PII collected through the verification process by default. Based on your needs and how you plan to use the PII, we allow selected attributes (e.g. name) to be accessed via API.

{
  "data": {
    "type": "inquiry"
    "id": "inq_2CVZ4HyVg7qaboXz2PUHknAn",
    "attributes": {
      "status": "approved",
      "reference-id": null,
      "created-at": "2019-09-09T22:40:56.000Z",
      "completed-at": "2019-09-09T22:44:51.000Z",
      "expired-at": null
    },
    "relationships": {
      "reports": {
        "data": []
      },
      "template": {
        "data": {
          "id": "tmpl_JAZjHuAT738Q63BdgCuEJQre",
          "type": "template"
        }
      },
      "verifications": {
        "data": [
          {
            "id": "ver_KnqQRXmxmtquRE65CHTzymhR",
            "type": "verification/driver-license"
          },
          {
            "id": "ver_2aguhcwq66zcmqipmrqjxw68",
            "type": "verification/selfie"
          }
        ]
      }
    },
  },
  "included": [
    {
      "type": "template"
      "id": "tmpl_JAZjHuAT738Q63BdgCuEJQre",
      "attributes": {
        "name": "Acme #1"
      },
    },
    {
      "type": "verification/driver-license"
      "id": "ver_KnqQRXmxmtquRE65CHTzymhR",
      "attributes": {
        "status": "passed",
        "front-photo-url": "...",
        "created-at": "2019-09-09T22:41:29.000Z",
        "completed-at": "2019-09-09T22:41:40.000Z",

        ...
      },
    },
    {
      "type": "verification/selfie"
      "id": "ver_2aguhcwq66zcmqipmrqjxw68",
      "attributes": {
        "status": "passed",
        "center-photo-url": "...",
        "left-photo-url": "...",
        "right-photo-url": "...",
        "created-at": "2019-09-09T22:42:43.000Z",
        "completed-at": "2019-09-09T22:42:46.000Z",

        ...
      },
    }
  ],
  "meta": {
    "session-token": "..."
  }
}