Submit a Customer Data Verification Attempt

POST 
/wallet-setup/verifications/:verificationId/attempts

Feature in development

Submits a verification attempt for a specific customer attribute tied to an already initiated verification process.

Once a verification process for a specific customer attribute is initiated and active (not expired or failed), the user has a limited number of attempts to complete it (e.g., enter the OTP code sent via email), as defined by the allowableAttempts. Each new verification attempt increments the currentAttempts count until it reaches the predefined limit. When the limit is reached, no further verification attempts for the same process are accepted and are automatically denied. There is no cooldown period, and the verification process is marked as failed. To retry the verification, a new verification process must be started, and the user can attempt the verification again.

Request

Path Parameters

verificationId stringrequired

A unique identifier for the verification process associated with a particular customer attribute.

application/json

Body

attribute

object

required

The customer attribute being attached to the particular verification process.

type Customer Data Verification Attribute Type (string)required

Possible values: [EMAIL, MOBILE]

The type of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

• EMAIL - The email address connected to the customer’s profile.
• MOBILE - The phone number registered with the customer’s account.

value stringrequired

The value of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

notificationType

object

required

The mechanism used to deliver the customer attribute verification information.

method Customer Data Verification Notification Method (string)required

Possible values: [OTP]

The notification method used for verifying the customer attribute.

• OTP - One-Time Password sent via email or SMS to the user's registered device.

channel Customer Data Verification Notification Channel (string)

Possible values: [EMAIL, SMS]

The notification channel used to send the verification method to the user.

• EMAIL - Verification method sent via email to the user's registered email address.
• SMS - Verification method sent via SMS to the user's registered phone.
value stringrequired

The value transmitted through the secure notification method and channel to confirm the specific customer attribute.

deviceInfo

object

required

Provides information about the device that the end-customer uses to access the service.

appType stringrequired

Possible values: [WEB_APP, MOBILE_APP, API]

The type of application used by the end-customer to access the service.

threatMetrixSessionId stringrequired

Possible values: <= 100 characters

ThreatMetrics session identifier.

Responses

201

Created

application/json

Schema

Schema

verificationAttemptId stringrequired

A unique identifier for the specific verification attempt associated with a particular verification process.

verificationId stringrequired

A unique identifier for the verification process associated with a particular customer attribute.

attribute

object

required

The customer attribute being attached to the particular verification process.

type Customer Data Verification Attribute Type (string)required

Possible values: [EMAIL, MOBILE]

The type of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

• EMAIL - The email address connected to the customer’s profile.
• MOBILE - The phone number registered with the customer’s account.

value stringrequired

The value of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

notificationType

object

required

The mechanism used to deliver the customer attribute verification information.

method Customer Data Verification Notification Method (string)required

Possible values: [OTP]

The notification method used for verifying the customer attribute.

• OTP - One-Time Password sent via email or SMS to the user's registered device.

channel Customer Data Verification Notification Channel (string)

Possible values: [EMAIL, SMS]

The notification channel used to send the verification method to the user.

• EMAIL - Verification method sent via email to the user's registered email address.
• SMS - Verification method sent via SMS to the user's registered phone.
currentAttempts integerrequired

The number of current attempts made to verify a particular customer attribute.

allowableAttempts integerrequired

The maximum number of allowed attempts to verify a particular customer attribute.

status Customer Data Verification Attempt Status (string)required
Possible values: [VERIFIED, REJECTED, FAILED]
The status of the verification attempt for a specific customer attribute.
• VERIFIED - The customer verification process has been successfully completed, and the user's attribute has been verified.
• REJECTED - The customer verification process has been rejected by the user.
• FAILED - The customer verification process has failed. Please refer to statusReason for further information.
statusReason string

Possible values: <= 100 characters

The reason for the failed verification attempt for a specific customer attribute.

creationTime date-timerequired

Represents creation RFC 3339, section 5.6 date-time.

Example (from schema)

{
  "verificationAttemptId": "80467c44-dca9-4139-aba9-ff5ed925913b",
  "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
  "attribute": {
    "type": "EMAIL",
    "value": "john.doe@example.com"
  },
  "notificationType": {
    "method": "OTP",
    "channel": "EMAIL"
  },
  "currentAttempts": 1,
  "allowableAttempts": 5,
  "status": "FAILED",
  "statusReason": "Invalid OTP code.",
  "creationTime": "2024-08-19T16:33:16Z"
}

OTP_EMAIL_VERIFIED

{
  "verificationAttemptId": "80467c44-dca9-4139-aba9-ff5ed925913b",
  "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
  "attribute": {
    "type": "EMAIL",
    "value": "john.doe@example.com"
  },
  "notificationType": {
    "method": "OTP",
    "channel": "EMAIL"
  },
  "currentAttempts": 1,
  "allowableAttempts": 5,
  "status": "VERIFIED",
  "creationTime": "2024-08-19T16:33:16Z"
}

OTP_EMAIL_FAILED

{
  "verificationAttemptId": "80467c44-dca9-4139-aba9-ff5ed925913b",
  "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
  "attribute": {
    "type": "EMAIL",
    "value": "john.doe@example.com"
  },
  "notificationType": {
    "method": "OTP",
    "channel": "EMAIL"
  },
  "currentAttempts": 1,
  "allowableAttempts": 5,
  "status": "FAILED",
  "statusReason": "Invalid OTP code.",
  "creationTime": "2024-08-19T16:33:16Z"
}

OTP_SMS_VERIFIED

{
  "verificationAttemptId": "80467c44-dca9-4139-aba9-ff5ed925913b",
  "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
  "attribute": {
    "type": "MOBILE",
    "value": "+359878787878"
  },
  "notificationType": {
    "method": "OTP",
    "channel": "SMS"
  },
  "currentAttempts": 2,
  "allowableAttempts": 5,
  "status": "VERIFIED",
  "creationTime": "2024-08-19T16:33:16Z"
}

OTP_SMS_FAILED

{
  "verificationAttemptId": "80467c44-dca9-4139-aba9-ff5ed925913b",
  "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c",
  "attribute": {
    "type": "MOBILE",
    "value": "+359878787878"
  },
  "notificationType": {
    "method": "OTP",
    "channel": "SMS"
  },
  "currentAttempts": 2,
  "allowableAttempts": 5,
  "status": "FAILED",
  "statusReason": "Invalid OTP code.",
  "creationTime": "2024-08-19T16:33:16Z"
}

400

Bad Request

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

MISSING_ATTRIBUTE_VALUE

{
  "error": {
    "code": "5068",
    "message": "Field error(s)",
    "details": [
      "Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
    ],
    "fieldErrors": [
      {
        "field": "attribute.value",
        "error": "must not be null"
      }
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INVALID_CREDENTIALS

{
  "error": {
    "code": "5279",
    "message": "Invalid credentials",
    "details": [
      "The authentication credentials are invalid."
    ]
  }
}

404

Not Found

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

CUSTOMER_VERIFICATION_PROCESS_NOT_FOUND

{
  "error": {
    "code": "DW-CUSTOMER-VERIFICATION-PROCESS-NOT-FOUND",
    "message": "Active customer verification process was not found",
    "details": [
      "No active customer verification process matching the provided data was found."
    ]
  }
}

429

Too Many Requests

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

CUSTOMER_VERIFICATION_ATTEMPTS_EXCEEDED

{
  "error": {
    "code": "DW-CUSTOMER-VERIFICATION-ATTEMPTS-EXCEEDED",
    "message": "Customer verification attempts exceeded",
    "details": [
      "Customer verification attempts exceeded the allowed limit."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

INTERNAL_SERVER_ERROR

{
  "error": {
    "code": "DW-INTERNAL-SERVER-ERROR",
    "message": "Internal Server Error",
    "details": [
      "There was an error while processing the operation"
    ]
  }
}

503

Service Unavailable

application/json

Schema

Schema

error

object

Additional details about the error.

code string

The error code.

message string

A description of the error.

details string[]

Details of any parameter value errors.

fieldErrors

object[]

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

SERVICE_UNAVAILABLE

{
  "error": {
    "code": "DW-SERVICE-UNAVAILABLE",
    "message": "Service Unavailable",
    "details": [
      "Service Unavailable"
    ]
  }
}

Loading...