VerifyVASP
Search…
⌃K

Callback API

post
VEGA_VERIFICATION_CALLBACK_API_PATH
Callback API for Verification Result Notification
Enclave Environment Variable:
Explicate the transaction process status inquiry API endpoint inVEGA_VERIFICATION_CALLBACK_API_PATH
Callback API enables the asynchronous preocessing of verification. Following 3 APIs work asynchronously.
  • User Verification API
  • Transaction Result Report API
  • Error Report API
Here are three typical cases of enclave calling callback API.
  • Enclave recieved a result of the past requested verficiation (callbackType: VERIFICATION_RESULT)
  • Enclave recieved an originating VASP sending report of txHash or txID which is matched to specific verification (callbackType: TX_REPORT)
  • Enclave recieved an originating VASP sending error report of specific verification (callbackType: ERROR_REPORT)
Response Time Requirement
The callback API must respond in 1 second after being called.
Implementation Policy
  • Callback API must return 200 OK status codes only.
  • API needs to respond in possibly the fastest timing, not processing complicated tasks.
  • Idempotent guaranteed implementation
    • Enclave can call callback API multiple times simultaneously to prevent data loss.
    • Therefore, the API developer needs to consider the duplicated case carefully. (e.g. Ignore duplicated requests after the first call)

Request Header

Field Name
Description
Authorization
Bearer <VEGA_VERIFICATION_AUTHORIZATION_TOKEN>

Request Body

Request Body Examples
Field Name
Data Type
Required
Description
callbackType
string
true
Callback API 가 어떠한 상황에서 호출되었는지 구분하는 값. (하단 설명 참조)
data
object
true
callbackType 에 따라 data 형식이 달라집니다. (위 샘플 코드 참조)
  • callbackType field specification is as follows.
    • Value must be one of "VERIFICATION_RESULT", "TX_REPORT", "ERROR_REPORT".
    • VERIFICATION_RESULT: Callback for result notification of past verification request
    • TX_REPORT: Callback for transaction result report from originating VASP
    • ERROR_REPORT: Callback for error report from originating VASP
  • data.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-ADDRESS
    DENIED
    The unknown wallet address
    Unknown wallet address to the VASP
    LACK-OF-INFORMATION
    DEINED
    A comma(,) separated required but missing personal information fields list
    Verification denied due to lack of personal information
    UNAVAILABLE-INFORMATION
    DEINED
    A comma(,) separated undeliverable personal information field list
    Requested personal information cannot be transferred for processing
    BLACKLISTED
    DEINED
    -
    Verification denied by probloems in sanction screening
    UNVERIFIED-KYC
    DEINED
    -
    User KYC required
    MISMATCHED-NAME
    DEINED
    -
    Name mismatch
    UNDEFINED-ERROR
    DEINED
    Error description
    Unexpected exceptional case happens
    BENEFICIARY-ACCOUNT-NOT-MATCHED
    ERROR
    -
    Beneficiary address is mismatched by VASP
    REQUEST-TIMEOUT
    ERROR
    -
    Verification processing exceeds the timeout limit

Response Body

Response Body Examples
Field Name
Data Type
Required
Example
Description
result
boolean
true
true
The Result value. (An error is not returned.)