Errors

To handle errors returned by Verified API endpoints, we recommend that you primarily use the respons body's data.errorCode, which is a Verified specific error code. See Error Codes below for descriptions of what each code means.

Error Type

This definition is also in Error in Types.

Error Type

{
    "name": string,
    "message": string,
    "code": number,
    "className": string,
    "data": {
        "errorCode": string
    }
}

Property	Type	Format	Description	Example
name	string	PascalCase	Name of the error	"BadRequest"
message	string	Sentence case	Message for developer that explains the error	"Additional information is required to source data for user: birthDate"
code	number	3 digits (0-9)	HTTP response status code	400
className	string	kebab-case	Class of error	bad-request
data.errorCode	enum Possible values (see Error Codes for details): "ERR001" "OCE001" "OCE002" "OCE003" "OCE004" "OCE005" "OCE006" "OCE007" "OCE008" "OCE009" "OCE0010" "OCE0011" "OCE0012" "OCE0013" "OCE0014" "OCE0015"	3 letters and 3 digits (0-9)	Verified error code	Verified specific error code (see Error Codes)	"OCE011"

Example

Error Example

{
    "name": "BadRequest",
    "message": "Additional information is required to source data for user: birthDate"
    "code": 400,
    "className": "bad-request",
    "data": {
        "errorCode": "OCE011"
    }
}

---

Error Codes

An errorCode is a Verified specific error code consisting of 3 letters and 3 numbers. Codes that begin with ERR are generic, and those that begin with OCE are specific to 1-Click Signup (OCE refers to a One Click Error).

ERR001

Generic error

messsage	"Generic error code"

OCE001

General error for 1-Click Signup

messsage	"1-click error code"

OCE002

Unsupported phone number for 1-Click Signup

messsage	"Unsupported phone number to use 1-Click"

OCE003

Either phone or email is required for 1-Click Signup

messsage	"Either "phone" or "email" is required"

OCE004

User not found for 1-Click Signup

messsage	"User not found"

OCE005

User credentials or credential requests are missing for 1-Click Signup

messsage	"User Credentials or Credential Requests are missing"

OCE006

User identifier is missing for 1-Click Signup

messsage	"User identifier is missing"

OCE007

Mandatory credentials are missing for 1-Click Signup

messsage	"Unable to use 1-click due to missing mandatory credentials"

This generally happens when the credential requests have mandatory credentials that data cannot be sourced for and for which user input is not allowed.

OCE008

Invalid or expired verification code for 1-Click Signup

messsage	"Invalid or expired verification code"

This only applies to a Semi-Hosted integration type.

OCE009

Verification code is required for 1-Click Signup

messsage	"Verification code is required"

This only applies to a Semi-Hosted integration type.

OCE010

Missing required fields to autofill credentials for 1-Click Signup

messsage	"Missing required fields to autofill credentials"

OCE011

Additional information is required to source data for user: {inputs}

messsage	"Additional information is required to source data for user: {inputs}"

The {inputs} included in message is a comma separated list of required additional information. Generally, it's a single item: birthDate.

Sandbox Birth Date Value

In Sandbox, for birthDate you need to use a value of "1989-08-01" to pass validation. Otherwise, you'll get a birth date mismatch error (OCE012 error code).

OCE012

Birth date mismatch

messsage	"BirthDate mismatch."

Sandbox Birth Date Value

In Sandbox, for birthDate you need to use a value of "1989-08-01" to pass validation. Otherwise, you'll get a birth date mismatch error (OCE012 error code).

OCE013

messsage	"No credentials found"

OCE014

messsage	"1-Click Request Expired"

This only applies to a Semi-Hosted integration type.

OCE015

messsage	"1-Click Not Found"