---
updatedAt: 2026-05-29T18:12:06.000Z
agentTools:
  projectIndex: https://docs.vouched.id/llms.txt
---

# Submit Identity CrossCheck

Provides a crosscheck of matching identities based on provided name, email, phone number, address, and IP address. The crosscheck is performed across a network of enriched data sources.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "version": "0.13.13",
    "title": "Vouched API",
    "description": "Official Vouched REST API.\n\n## Environments\n\nThe `servers` list below has two production hosts: `verify.vouched.id` (US) and\n`verify.eu.vouched.id` (EU). A separate **sandbox** deployment runs the same service with\n`SANDBOX_MODE` enabled, where only the identity-verification job endpoints are mounted —\n`GET`/`POST /api/jobs`, `GET`/`DELETE /api/jobs/{id}`, `GET /api/jobs/{id}/download` and\n`POST /api/jobs/session`. Every other endpoint **under `/api`** in this document returns **404**\nin sandbox, including AML, SSN, TIN, DOB, invites and CrossCheck.\n\nThe provider webhook receivers are the exception: `/api/tin/webhook`,\n`/api/dlv/webhook/license-validation`, `/v1/sendgrid/email/send` and `/v1/twilio/sms/send` are\nregistered outside the sandbox gate and remain available.\n",
    "x-logo": {
      "url": "https://i.pinimg.com/originals/88/29/2f/88292f8ffd6231d0c41634f2e707c34a.png",
      "altText": "Vouched logo"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "https://verify.vouched.id",
      "description": "US (default)"
    },
    {
      "url": "https://verify.eu.vouched.id",
      "description": "EU"
    }
  ],
  "tags": [
    {
      "name": "crosscheck",
      "description": "This is the section where you will do actions for all things related to CrossCheck."
    }
  ],
  "paths": {
    "/api/identity/crosscheck": {
      "post": {
        "description": "Provides a crosscheck of matching identities based on provided name, email, phone number, address, and IP address. The crosscheck is performed across a network of enriched data sources.",
        "summary": "Submit Identity CrossCheck",
        "operationId": "crossCheck",
        "security": [
          {
            "X-API-Key": []
          }
        ],
        "tags": [
          "crosscheck"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/crosscheck_request"
              },
              "examples": {
                "0": {
                  "value": {
                    "firstName": "John",
                    "lastName": "Bao",
                    "email": "test@test.acme.com",
                    "phone": "000-111-2222",
                    "ipAddress": "73.19.102.110",
                    "address": {
                      "unit": "",
                      "streetAddress": "123 Elmo Avenue",
                      "city": "Seattle",
                      "state": "WA",
                      "postalCode": "98109",
                      "country": "US"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Crosschecking a job",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/identity_crosscheck"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "X-API-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "The authentication private key"
      }
    },
    "schemas": {
      "gender_distribution": {
        "type": "object",
        "properties": {
          "man": {
            "type": [
              "number",
              "null"
            ],
            "description": "Frequency of the first name in men with a minimum found frequency of 0.0001. Null when the first name is unknown.",
            "minimum": 0
          },
          "woman": {
            "type": [
              "number",
              "null"
            ],
            "description": "Frequency of the first name in women with a minimum found frequency of 0.0001. Null when the first name is unknown.",
            "minimum": 0
          }
        }
      },
      "crosscheck_identity_errors": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of error encountered."
          },
          "warnings": {
            "type": "boolean",
            "description": "Is this a warning?"
          },
          "message": {
            "type": "string",
            "description": "Details on the occurring error."
          },
          "suggestion": {
            "type": "string",
            "example": "John Smith",
            "description": "A suggestion for matching name."
          }
        }
      },
      "crosscheck_age_range": {
        "type": "object",
        "properties": {
          "from": {
            "type": "integer",
            "description": "From age"
          },
          "to": {
            "type": "integer",
            "description": "To age"
          }
        }
      },
      "crosscheck_identity_address": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "isValid": {
            "type": "boolean",
            "description": "The address is a verified address."
          },
          "isMatch": {
            "type": "boolean",
            "description": "The name on the address matches the user."
          },
          "name": {
            "type": "string",
            "description": "The recorded name of the identity."
          },
          "ageRange": {
            "description": "The age range of the name on the address.",
            "type": "object",
            "$ref": "#/components/schemas/crosscheck_age_range"
          },
          "isForwarder": {
            "type": "boolean",
            "description": "The address is a freight forwarding address."
          },
          "isCommercial": {
            "type": "boolean",
            "description": "The address is associated with a business."
          },
          "type": {
            "type": "string",
            "enum": [
              "incomplete-address",
              "po-box",
              "multi-unit",
              "single-unit",
              "commercial-mail-drop",
              "po-box-forward",
              "other"
            ]
          }
        }
      },
      "crosscheck_identity_email": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "isValid": {
            "type": "boolean",
            "description": "The email is a valid email address."
          },
          "isMatch": {
            "type": "boolean",
            "description": "The name associated with the email address matches the user."
          },
          "name": {
            "type": "string",
            "description": "The recorded name of the identity."
          },
          "ageRange": {
            "description": "The age range of the name on the email address.",
            "type": "object",
            "$ref": "#/components/schemas/crosscheck_age_range"
          },
          "isAutoGenerated": {
            "type": "boolean",
            "description": "Indicates the email address was generated automatically."
          },
          "isDisposable": {
            "type": "boolean",
            "description": "The email address is provided by a disposable email provider."
          },
          "daysFirstSeen": {
            "type": "integer",
            "description": "The number of days since the email address was first seen in the data network."
          }
        }
      },
      "crosscheck_identity_phone": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/crosscheck_identity_errors"
            }
          },
          "isValid": {
            "type": "boolean",
            "description": "The phone number is valid."
          },
          "isMatch": {
            "type": "boolean",
            "description": "The name associated with the phone number matches the user."
          },
          "name": {
            "type": "string",
            "description": "The recorded name of the identity."
          },
          "type": {
            "type": "string",
            "enum": [
              "fixed-voip",
              "landline",
              "mobile",
              "non-fixed-voip",
              "premium-rate",
              "tollfree",
              "voicemail",
              "other"
            ]
          },
          "ageRange": {
            "description": "The age range of the name associated with the phone number.",
            "type": "object",
            "$ref": "#/components/schemas/crosscheck_age_range"
          },
          "carrier": {
            "type": "string",
            "description": "The phone provider."
          },
          "isPrepaid": {
            "type": "boolean",
            "description": "The phone number is on a prepaid plan."
          },
          "isDisposable": {
            "type": "boolean",
            "description": "The phone number is disposable."
          },
          "isCommercial": {
            "type": "boolean",
            "description": "The phone number is associated with a business."
          }
        }
      },
      "location": {
        "type": "object",
        "properties": {
          "latitude": {
            "type": "number"
          },
          "longitude": {
            "type": "number"
          }
        }
      },
      "ip_address": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "Originating City."
          },
          "state": {
            "type": "string",
            "description": "Originating State/Province/Territory in [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2)."
          },
          "country": {
            "type": "string",
            "description": "Originating Country in [ISO 3166-1 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
          },
          "postalCode": {
            "type": "string",
            "description": "postal code."
          },
          "location": {
            "type": "object",
            "$ref": "#/components/schemas/location"
          },
          "isp": {
            "type": "string",
            "description": "Name of the isp."
          },
          "organization": {
            "type": "string",
            "description": "Name of the organization associated with the IP address."
          },
          "isAnonymous": {
            "type": "boolean",
            "description": "Is the IP address part of an anonymous network."
          },
          "isAnonymousVpn": {
            "type": "boolean",
            "description": "Is the IP address part of an anonymous vpn network."
          },
          "isAnonymousHosting": {
            "type": "boolean",
            "description": "Is the IP address part of an anonymous hosting network."
          },
          "userType": {
            "type": "string",
            "description": "A description of the internet access point.",
            "enum": [
              "business - the IP address belongs to a business ISP or a corporation.",
              "cafe - an internet cafe or similar location.",
              "cellular - the IP address is used to route traffic from devices connected to a cellular network.",
              "college - the IP address belongs to a college, university, or similar institute of higher education.",
              "content_delivery_network - belongs to a CDN (Akamai, Cloudflare, Google Cloud, etc.).",
              "dialup - belongs to a dial-up ISP.",
              "government - the IP address belongs to a government organization.",
              "hosting -- a commercial hosting provider.",
              "library - used in a library.",
              "military - used on a military base or similar.",
              "residential - the IP address belongs to a residential ISP or is otherwise primarily used by home users.",
              "router - a backbone or infrastructure router.",
              "school - primary or secondary education.",
              "search_engine_spider - a crawler or indexer for a search engine (Google, Bing, Yahoo, etc.).",
              "traveler - the IP address is used at an airport, hotel, or similar location where the users are generally traveling from their primary residence."
            ]
          }
        }
      },
      "crosscheck_confidences": {
        "type": "object",
        "properties": {
          "identity": {
            "type": "number",
            "description": "Overall identity risk confidence. The identity score is a risk score assigned to the user based on their address, email, and phone details. These details are cross-referenced against the data provided by the user or the extracted from their ID.",
            "minimum": 0,
            "maximum": 1
          },
          "originalIdentity": {
            "type": "number",
            "description": "The rules-based identity score before it was replaced by the account's crosscheck model. Only returned when a model overrode `identity`.",
            "minimum": 0,
            "maximum": 1
          },
          "modelIdentity": {
            "type": "number",
            "description": "The crosscheck model's likelihood that the user is genuine, before Strict Name Linkage was applied. Only returned when the account has Strict Name Linkage enabled and a model scored the job.",
            "minimum": 0,
            "maximum": 1
          },
          "activity": {
            "type": [
              "number",
              "null"
            ],
            "description": "Overall activity risk confidence that is based on dynamic attributes."
          }
        }
      },
      "crosscheck_cip_result": {
        "type": "object",
        "description": "CIP (Customer Identification Program) outcome. Only returned when CIP scoring is enabled for the account. Does not affect the existing score, errors or other response fields.",
        "required": [
          "version",
          "pass",
          "address"
        ],
        "properties": {
          "version": {
            "type": "integer",
            "description": "CIP model version."
          },
          "pass": {
            "type": "boolean",
            "description": "CIP pass/fail. The address is matched to the applicant and valid; email and phone are excluded from the decision."
          },
          "address": {
            "type": "object",
            "description": "The CIP element evaluated by CrossCheck.",
            "required": [
              "match",
              "valid"
            ],
            "properties": {
              "match": {
                "type": "boolean",
                "description": "The address is matched to the applicant."
              },
              "valid": {
                "type": "boolean",
                "description": "The address is a real, deliverable address."
              }
            }
          },
          "email": {
            "type": "object",
            "description": "Optional. Non-CIP signal, excluded from the CIP decision. Omitted when not evaluated.",
            "required": [
              "match",
              "valid"
            ],
            "properties": {
              "match": {
                "type": "boolean",
                "description": "The email is matched to the applicant."
              },
              "valid": {
                "type": "boolean",
                "description": "The email is real and deliverable."
              }
            }
          },
          "phone": {
            "type": "object",
            "description": "Optional. Non-CIP signal, excluded from the CIP decision. Omitted when not evaluated.",
            "required": [
              "match",
              "valid"
            ],
            "properties": {
              "match": {
                "type": "boolean",
                "description": "The phone is matched to the applicant."
              },
              "valid": {
                "type": "boolean",
                "description": "The phone is real and in service."
              }
            }
          }
        }
      },
      "crosscheck_result": {
        "type": "object",
        "description": "CrossCheck Result",
        "properties": {
          "address": {
            "description": "Address match details, or null when no address was submitted or matched.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/crosscheck_identity_address"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "description": "Email match details, or null when no email was submitted or matched.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/crosscheck_identity_email"
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "description": "Phone match details, or null when no phone was submitted or matched.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/crosscheck_identity_phone"
              },
              {
                "type": "null"
              }
            ]
          },
          "gender": {
            "type": "object",
            "$ref": "#/components/schemas/gender_distribution"
          },
          "ageRange": {
            "deprecated": true,
            "description": "Always null. The age range derived from the identity is returned on `email.ageRange`.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/crosscheck_age_range"
              },
              {
                "type": "null"
              }
            ]
          },
          "ip": {
            "description": "Validity of the submitted IP address and its distance from the submitted address. Null when no IP result is available.",
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "isValid": {
                "type": "boolean",
                "description": "Whether the IP address was resolved to a valid location."
              },
              "distance": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Distance between the IP address location and the submitted address. Null when it cannot be computed."
              }
            }
          },
          "ipAddress": {
            "description": "IP address inspection details. Only returned for standalone crosscheck requests, and null when no IP address was submitted.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/ip_address"
              },
              {
                "type": "null"
              }
            ]
          },
          "model": {
            "type": "string",
            "description": "The crosscheck model used to score the identity. Only returned when the account is configured with a crosscheck model and its inference succeeded.",
            "enum": [
              "fraud",
              "approval"
            ]
          },
          "nameLinked": {
            "type": "boolean",
            "description": "Whether at least one of the submitted address, email or phone is linked to the submitted name; fields that weren't submitted don't count as linked. When `false`, `confidences.identity` is scaled to `threshold * min(0.999, score)` so it falls below the account's CrossCheck identity threshold while keeping a representative score. `score` is the model's score (`confidences.modelIdentity`), or the rules-based score when the model was unavailable. Only returned when the account has Strict Name Linkage enabled and a crosscheck model configured."
          },
          "confidences": {
            "type": "object",
            "$ref": "#/components/schemas/crosscheck_confidences"
          },
          "cip": {
            "type": "object",
            "$ref": "#/components/schemas/crosscheck_cip_result"
          }
        }
      },
      "error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "\nError type code.\n- InvalidRequestError - The request is invalid.\n\n  - Parameters sent in the request are invalid.\n\n\n- FaceMatchError - The face match score was lower than the threshold.\n\n  - Category: faceMatch\n\n  - Faces obtained from the ID and Selfie images do not match.\n\n\n- NameMatchError - The name match score was lower than the threshold.\n\n  - The name provided by the user and the name extracted from the ID do not match.\n\n  - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BarcodeMatchError - The barcode match score was lower than the threshold.\n\n  - The data provided by the user and the data extracted from the barcode do not match. \n\n  - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BirthDateMatchError - The birth date match score was lower than the threshold.\n\n  - The birth date provided by the user and the data extracted from the ID do not match.\n\n  - Eg: User Provided DOB - 01/09/1992, Extracted DOB - 09/01/1992\n\n  - Eg: User Provided DOB - 11/09/1992, Extracted DOB - 12/09/1992\n\n\n- ExpiredIdError - The ID’s expiration date has passed.\n\n  - The expiration date extracted from the ID indicates that it has expired.\n\n- InvalidIdPhotoError - The ID is invalid.\n\n  - Category: id\n\n  - The image submitted does not qualify as an ID. The ID image may be of lower quality, have blur, glare or it may be too dark, and hence the data could not be extracted.\n\n- InvalidUserPhotoError - The user photo (selfie) is invalid.\n\n  - Category: selfie\n\n  - The image submitted does not qualify as a selfie.\n\n- BarcodeDetectError - The barcode could not be detected on the ID.\n- AuthenticationError - The request could not be authenticated.\n\n  - The key could not be verified.\n\n- NotFoundError - The requested resource does not exist, or is not visible to this account.\n- ConflictError - The request conflicts with the current state of the resource.\n- AccountConfigErrorType - The feature is not enabled for this account.\n- SSNAccountConfigErrorType - SSN verification is not enabled for this account. Returned by the SSN endpoints in place of `AccountConfigErrorType`.\n- SSNUnprocessableEntityErrorType - The eCBSV request contains incorrectly formatted or missing data.\n- UnknownSystemError - A unknown system error occurred.\n- LivenessSkippedError - Selfie liveness was skipped.\n- LivenessScoreError - The selfie liveness score was below the threshold.\n- LivenessCompletionError - The selfie liveness check did not complete.\n- DarkWebError - The dark web check result was below the threshold.\n- ipAddressError - The IP address check result was below the threshold.\n- AMLError - The AML screening result was below the threshold.\n- MissingIdentityErrorType - No identity document was supplied.\n- RestrictedIdDocumentError - The identity document did not meet the account's configured constraints.\n- CrosscheckIdentityError - The CrossCheck identity score was below the threshold.\n- StableSelfiePatternError - An unstable selfie pattern was detected.\n- StableIdPatternError - An unstable ID pattern was detected.\n- DocumentVoidedError - The document has been voided.\n- DlvError - The ID did not pass Driver's License Verification.",
            "enum": [
              "InvalidRequestError",
              "FaceMatchError",
              "NameMatchError",
              "BarcodeMatchError",
              "BarcodeDetectError",
              "BirthDateMatchError",
              "ExpiredIdError",
              "InvalidIdPhotoError",
              "InvalidUserPhotoError",
              "AuthenticationError",
              "NotFoundError",
              "ConflictError",
              "AccountConfigErrorType",
              "SSNAccountConfigErrorType",
              "SSNUnprocessableEntityErrorType",
              "UnknownSystemError",
              "LivenessSkippedError",
              "LivenessScoreError",
              "LivenessCompletionError",
              "DarkWebError",
              "ipAddressError",
              "AMLError",
              "MissingIdentityErrorType",
              "RestrictedIdDocumentError",
              "CrosscheckIdentityError",
              "StableSelfiePatternError",
              "StableIdPatternError",
              "DocumentVoidedError",
              "DlvError"
            ]
          },
          "message": {
            "type": "string",
            "description": "Details on the occurring error."
          },
          "warning": {
            "type": "boolean",
            "description": "Is this a warning?"
          },
          "suggestion": {
            "example": "John Smith",
            "description": "A suggestion for matching name.",
            "type": "string"
          }
        }
      },
      "errors": {
        "type": "object",
        "description": "One or more errors describing why the request failed.",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/error"
            }
          }
        }
      },
      "token_error_response": {
        "type": "object",
        "description": "Returned by the JWT middleware, which runs ahead of all routers and so can answer any path. Note this is a single `error` string, not the `errors` array used by the rest of the API.",
        "properties": {
          "error": {
            "type": "string",
            "enum": [
              "Token expired",
              "Token malformed"
            ]
          }
        }
      },
      "verification_property": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "description": "Name of the property"
          },
          "value": {
            "type": "string",
            "maxLength": 1024,
            "description": "Value of the property"
          }
        },
        "required": [
          "name",
          "value"
        ]
      },
      "verification_properties": {
        "type": "array",
        "description": "Optional list of arbitrary customer supplied properties, echoed back on the job response and omitted from it when none were sent. Intended for attributing the result in your own system — send an identifier you can look up rather than the record itself. At most 5 entries. The same values are also returned for this job by `GET /api/jobs` under `request.properties`, where they are `null` rather than omitted when none were sent.",
        "maxItems": 5,
        "items": {
          "$ref": "#/components/schemas/verification_property"
        }
      },
      "base_address": {
        "type": "object",
        "description": "Address",
        "properties": {
          "unit": {
            "type": "string",
            "description": "Unit number."
          },
          "streetAddress": {
            "type": "string",
            "description": "Street Address."
          },
          "city": {
            "type": "string",
            "description": "City."
          },
          "state": {
            "type": "string",
            "description": "Two-character state code associated with the phone number. [state code](https://www.faa.gov/air_traffic/publications/atpubs/cnt_html/appendix_a.html)"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal Code."
          },
          "country": {
            "type": "string",
            "description": "The [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
          }
        }
      },
      "crosscheck_request": {
        "type": "object",
        "description": "CrossCheck Request",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email address."
          },
          "phone": {
            "type": "string",
            "description": "Phone number. Defaults to +1 (US and CA). Country code required for other countries.",
            "example": "000-111-2222"
          },
          "firstName": {
            "type": "string",
            "description": "First Name."
          },
          "lastName": {
            "type": "string",
            "description": "Last Name."
          },
          "address": {
            "type": "object",
            "$ref": "#/components/schemas/base_address"
          },
          "ipAddress": {
            "type": "string",
            "description": "IP Address."
          },
          "jobId": {
            "type": "string",
            "description": "Associate the crosscheck with an existing job id instead of generating a new one."
          },
          "properties": {
            "$ref": "#/components/schemas/verification_properties"
          }
        },
        "required": [
          "firstName",
          "lastName"
        ]
      },
      "identity_crosscheck": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the request."
          },
          "request": {
            "type": "object",
            "description": "Request object for crosscheck.",
            "$ref": "#/components/schemas/crosscheck_request"
          },
          "result": {
            "type": "object",
            "description": "Result object for crosscheck.",
            "$ref": "#/components/schemas/crosscheck_result"
          }
        }
      }
    },
    "responses": {
      "400": {
        "description": "InvalidRequestError - The request is invalid. An aborted or oversized request is answered with this status and an empty body instead of the envelope below.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            },
            "example": {
              "errors": [
                {
                  "type": "InvalidRequestError",
                  "message": "Invalid request"
                }
              ]
            }
          }
        }
      },
      "401": {
        "description": "The request could not be authenticated. Credential rejection returns an `AuthenticationError` envelope; a malformed or expired bearer token is rejected earlier by the JWT middleware and returns `{ \"error\": \"Token expired\" }` or `{ \"error\": \"Token malformed\" }` instead.",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/errors"
                },
                {
                  "$ref": "#/components/schemas/token_error_response"
                }
              ]
            },
            "example": {
              "errors": [
                {
                  "type": "AuthenticationError",
                  "message": "Unauthorized access"
                }
              ]
            }
          }
        }
      },
      "500": {
        "description": "UnknownSystemError - A unknown system error occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            },
            "example": {
              "errors": [
                {
                  "type": "UnknownSystemError",
                  "message": "Oops, we encountered a problem"
                }
              ]
            }
          }
        }
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "APIs",
      "tags": [
        "jobs",
        "invites",
        "crosscheck",
        "aml",
        "ssn",
        "tin",
        "dob",
        "documents"
      ]
    },
    {
      "name": "Internal",
      "tags": [
        "client",
        "digital-id",
        "admin",
        "webhooks"
      ]
    }
  ]
}
```