Verify Card

POST 
/profile/verifications/CARD

Perform card verification using verification code from previous successful transactions. The verification is required if either forced by risk and compliance or the card lifetime limit is reached.

Request

Header Parameters

Content-Type stringrequired

Default value: application/json

application/json

application/json

Body

verificationCode stringrequired

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^\d{4}$

Verificaton code present in the statement of previous transaction.

instrumentId stringrequired

Card identifier.

verificationType CardVerificationType (string)required

Possible values: [VERIFICATION_CODE]

Default value: VERIFICATION_CODE

Type of the card verification performed.

Responses

200

The instrument verification allows tracking the verification outcome.

application/json

Schema

Schema

verificationCode stringrequired

Possible values: >= 4 characters and <= 4 characters, Value must match regular expression ^\d{4}$

Verificaton code present in the statement of previous transaction.

instrumentId stringrequired

Card identifier.

verificationType CardVerificationType (string)required

Possible values: [VERIFICATION_CODE]

Default value: VERIFICATION_CODE

Type of the card verification performed.

id stringrequired

Card verification id.

creationTime date-timerequired

Represents RFC 3339, section 5.6 date-time.

status CardVerificationStatus (string)required

Possible values: [COMPLETED, FAILED]

Card verification status.

statusReason CardVerificationStatusReason (string)

Possible values: [INVALID_CODE, VERIFICATION_NOT_REQUIRED, VERIFICATION_ATTEMPT_EXCEEDED, VERIFICATION_ATTEMPT_24H_EXCEEDED]

The reason for FAILED card verification.

instrumentType InstrumentType (string)

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Instrument type.

| Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

remainingAttempts integer

The remaining card verification attempts.

Example (from schema)

{
  "verificationCode": "string",
  "instrumentId": "1001",
  "verificationType": "VERIFICATION_CODE",
  "id": "2cb56b2749af52d6b257054ef3de0",
  "creationTime": "2021-07-15T17:54:12Z",
  "status": "COMPLETED",
  "statusReason": "INVALID_CODE",
  "instrumentType": "CARD",
  "remainingAttempts": 0
}

VERIFICATION_SUCCESS

{
  "verificationCode": "1234",
  "id": "2cb56b2749af52d6b257054ef3de0",
  "instrumentType": "CARD",
  "verificationType": "VERIFICATION_CODE",
  "creationTime": "2021-07-15T17:54:12Z",
  "status": "COMPLETED",
  "remainingAttempts": 0
}

VERIFICATION_FAIL

{
  "verificationCode": "1234",
  "id": "2cb56b2749af52d6b257054ef3de0",
  "instrumentType": "CARD",
  "verificationType": "VERIFICATION_CODE",
  "creationTime": "2021-07-15T17:54:12Z",
  "status": "FAILED",
  "statusReason": "INVALID_CODE",
  "remainingAttempts": 4
}

400

Validation failed.

application/json

Schema

Schema

error

object

Additional details about an 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"
      }
    ]
  }
}

Instrument type validation

{
  "error": {
    "code": "DW-INVALID-INSTRUMENT-TYPE-FOR-VERIFICATION",
    "message": "The provided instrument type is not supported for instrument verification.",
    "details": [
      "The provided instrument type is not supported for instrument verification."
    ]
  }
}

500

Internal Server Error

application/json

Schema

Schema

error

object

Additional details about an 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": "1000",
    "message": "Internal Error",
    "details": [
      "An internal error occurred."
    ]
  }
}

Loading...