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
  • Transaction status query API
  • Request Body
  • Response Body
  • Success case
  • Error Codes
  1. Reference
  2. Enclave API Reference
  3. v1

Transaction Status Query

Transaction status query API

POST http://<enclave-endpoint>/v1/verifications/tx/inquiry

A VASP can check a transaction status if it has not received a transaction ID (txHash) report from an originating VASP in a duration.

Policy

  • When the beneficiary VASP detects a deposit transaction, the VASP can do txHash filtering to find candidates and call the verification result checking API to find a matched verification history.

  • If there is no exact matching txHash found in filtering, the VASP can wait for the transaction result report from the originating VASP.

  • When there is no report in a while, the beneficiary VASP can call the verification result checking API to filter out the candidates.

    • Setting the originator account number to 'from address' and beneficiary account number to 'to address' can narrow down the candidates.

    • Comparison of the transaction amounts is also helpful for filtering out.

  • You can find the final candidate of verification history by checking the transaction status for each of the candidates.

Request Body

Request Body Examples
{
    "verificationUuid": "8557f2b2-985e-431f-8d52-75c2e5a01e46"
}
Field Name
Data Type
Required
Example
Description

verificationUuid

string

true

“8557f2b2-985e-431f-8d52-75c2e5a01e46”

UUID of completed verification. UUID which was used as a key during /verification process before sending Transaction to the blockchain.

Response Body

Success case

Response Body Examples
  • 200 OK

{
  "verificationUuid": "8557f2b2-985e-431f-8d52-75c2e5a01e46",
  "transactionStatus": "PROCESSING",
  "txHash": ""
}
  • 200 OK

{
  "verificationUuid": "8557f2b2-985e-431f-8d52-75c2e5a01e46",
  "transactionStatus": "CONFIRMED",
  "txHash": "8a54d58ca4100112a5430818776d74898f2232770bae03046862575cb851a042",
  "vout": "2"
}
Field Name
Data Type
Example
Required
Description

verificationUuid

string

"8557f2b2-985e-431f-8d52-75c2e5a01e46"

true

UUID of completed verification.

transactionStatus

string

"PROCESSING"

true

Transaction Status.

txHash

string

"8a54d58ca4100112a5430818776d74898f2232770bae03046862575cb851a042"

false

TxHash (Transaction ID), Returned only in available.

vout

string

"2"

false

An index value indicating which transfer corresponds to within a single transaction, returned only if exist.

  • transactionStatus field specification is as follows.

    • PENDING: Blockchain transaction transmission is blocked for some reason.

    • PROCESSING: Waiting to be mined after transaction transmission.

    • WAIT-CONFIRM: The transaction is mined to block but not finalized yet.

    • CONFIRMED: The finality of the transaction is confirmed after being mined to block.

    • CANCELED: Blockchain transaction is canceled with or without starting transmission.

Error Codes

Mandatory parameter missing

Response Body Examples
  • 400 Bad Request

{
  "code": "MISSING-VERIFICATION-UUID",
  "message": "`verificationUuid` is required."
}

Invalid verification UUID input

Response Body Examples
  • 400 Bad Request

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

A mismatch of the Ordering VASP with the beneficiary VASP

Response Body Examples
  • 400 Bad Request

{
  "code": "VASP-NOT-MATCHED",
  "message": "You are not the beneficiary VASP for the verification"
}
PreviousError ReportNextVASP API Reference

Last updated 1 year ago

Transaction state transition diagram