error-type

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
        identifiers?: {
            [identifierKey: string]: string
        },
        verificationMethod?: {
            [identifierKey: string]: string
        },
        riskSignals?: RiskSignals // only for error codes OCE011, OCE012, OCE013, OCE017, and OCE019
        attemptsRemaining?: integer, // only for OCV error codes
        expiresAt?: integer // only for OCV error codes
    }
}

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.identifiers	Object	camelCase	Identifiers includede in the request	["birthDate", "ssn4"]
data.verificationMethod	Object	camelCase	Verification method for identifiers includede in the request	["birthDate", "ssn4"]
identifierKey	enum Possible values (see identifiers for details): phone email	camelCase	The type of identifier	"phone"
data.riskSignals	RiskSignals	Object	Verified risk signals associated with the 1-Click Signup event (only included for OCE011, OCE012, OCE013, OCE017, and OCE019)	See RiskSignals example
data.atteptsRemaining	integer	Any number of digits (0-9)	How many verification attempts the user has remaining	3
data.expiresAt	integer	Unix time (milliseconds)	When the verification expires (meaning it can no longer succeed)	1760053995000