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,
        "additionalInputs": [string], // only for error code OCE011
        "inputAttemptsExceeded": [string], // only for error code OCE019
        "riskSignals": RiskSignals // only for error code OCE017
    }
}

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 See Error Codes for possible values	3 letters and 3 digits (0-9)	Verified error code	"OCE011"
data.additionalInputs	[string]	camelCase	Additional inputs to source credentials for user, where multiple values indicates inclusive OR (only included for OCE011)	["birthDate", "ssn4"]
data.inputAttemptsExceeded	[string]	camelCase	Input(s) for which the attempts limit (3 for each input) has been exceeded (only included for OCE019)	["birthDate", "ssn4"]
data.riskSignals	RiskSignals	Object	Verified risk signals associated with the 1-Click Signup event	See RiskSignals example

Example

Error Example

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

---

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.)