VerifyVASP
  • Welcome
  • Change Log
  • Getting Started
    • Getting Started with VerifyVASP
    • Product Overview
    • Alliance Registration & API Key Creation
    • VASP API Functionality
    • Database
    • Enclave Installation & Execution
    • Security Guide
    • Robot VASP Utilization
    • Enclave Server API Utilization
    • Enclave Server Health Monitoring & Troubleshooting
  • Reference
    • Enclave API Reference
      • v1
        • VASP ID
        • VASP List
        • Screening API
          • Risk Assessment with Chainalysis Sanction API
          • Risk Assessment with Chainalysis KYT API
          • Risk Assessment with Refinitiv WCO API
        • User Account Verification
        • User Verification
        • Verification Result List
        • Verification Result by UUID
        • Transaction Result Report
        • Error Report
        • Transaction Status Query
    • VASP API Reference
      • User Account Verification
      • User Verification
      • Transaction Status Query
      • Callback API
      • Decrypting Database Encryption Key
    • IVMS101 Guide
      • About IVMS101 Standard
      • IVMS101 Message Format Guide
      • IVMS101 Personal Data Fields
    • Supplement
      • Network Field
      • Wallet address and transaction ID standards
    • Glossary
Powered by GitBook
On this page
  • Error Report
  • Request Body
  • Response Body
  • Success case
  • Error Codes
  1. Reference
  2. Enclave API Reference
  3. v1

Error Report

Error Report

POST http://<enclave-endpoint>/v1/verifications/error

This API reports an unsuccessful result to the beneficiary VASP.

For example, even if the verification was done successfully, a transaction might not proceed because of an internal issue (e.g. the beneficiary is in the sanction list). Then, the error status must be shared with the beneficiary VASP.

Policy

  • The originating VASP MUST report the error circumstance to VerifyVASP as soon as it decides to cancel the transaction permanently.

  • The report helps the beneficiary VASP stop unnecessary inquiries about the canceled transaction.

Request Body

Request Body Examples
{
  "result": "DENIED",
  "reason": "BLACKLISTED",
  "message": "Beneficiary person is in blacklist.",
  "verificationUuid": "8557f2b2-985e-431f-8d52-75c2e5a01e46"
}
Field Name
Data Type
Required
Example
Description

result

string

true

"VERIFIED"

Error Result. One of 'VERIFIED', 'DENIED', 'UNKNOWN', 'ERROR', 'PENDING', and 'TRANSFER_ERROR.'

reason

string

true

"OK"

A detailed reason for the result

message

string

false

-

Message description for the error code

verificationUuid

string

true

"64ab871b-14a3-47df-9b80-368e29fe8180"

User verification request ID

  • reason field specification is as follows.

    • The field is valid only when result the field is DENIED.

    • Refer to the below table for the message field value.

reason (string)
result (string)
message (string)
Description

UNKNOWN-SYMBOL

DENIED

The value of symbol name (which is not supported in VASP)

Unknown or not supported asset symbol

UNKNOWN-NETWORK

DENIED

The value of network name (which is not supported in VASP)

Unknown or not supported blockchain network (i.e. symbol matches but network does not)

UNKNOWN-ADDRESS

DENIED

The unknown wallet address

Unknown wallet address to the VASP

LACK-OF-INFORMATION

DENIED

A comma(,) separated required but missing personal information fields list

Verification denied due to lack of personal information

UNAVAILABLE-INFORMATION

DENIED

A comma(,) separated undeliverable personal information field list

Requested personal information cannot be transferred for processing

BLACKLISTED

DENIED

-

Verification denied having problems in sanction screening

UNVERIFIED-KYC

DENIED

-

User KYC required

MISMATCHED-NAME

DENIED

-

Name mismatch

NOT-ALLOWED

DENIED

The reason why it is not allowed

The originating VASP reject the user's withdrawal request for any reason.

UNDEFINED-ERROR

DENIED

Error description

Unexpected exceptional case happens

Response Body

Success case

Response Body Examples
  • 200 OK

{
  "result": true
}

Response Body

Field Name
Data Type
Required
Description

result

boolean

true

Whether error reporting on the beneficiary VASP has been completed

Error Codes

Missing parameter

Response Body Examples
  • 400 Bad Request

{
  "code": "MISSING-RESULT",
  "message": "`result` is required."
}

Invalid parameter input

Response Body Examples
  • 400 Bad Request

{
  "code": "INVALID-RESULT",
  "message": "`result` should be one of 'VERIFIED', 'DENIED', 'ERROR'."
}

Invalid verification UUID input.

Response Body Examples
  • 400 Bad Request

{
  "code": "VERIFICATION-NOT-FOUND",
  "message": "Verification(9faab87c-54a6-4145-baa9-7a3a42d7410c) is not found"
}
PreviousTransaction Result ReportNextTransaction Status Query

Last updated 1 year ago