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
  • View the List of VASPs
  • Request
  • Responses
  1. Reference
  2. Enclave API Reference
  3. v1

VASP List

View the List of VASPs

GET http://<enclave-endpoint>/v1/vasps

This API returns the list of VASPs.

When a withdrawal is requested to your VASP, your VASP can call this API to find the vaspId (ID of the VASP) of the Beneficiary VASP

Your VASP will only see list of VASP using Travel Rule protocol and be able to communicate with VASP in the list

Request

Query Parameters

Field Name
Data Type
Description
Default

protocol

string

The name of protocol that your VASP wants to look up(e.g. VERIFYVASP or etc.)

all

Responses

Response Body Examples
  • 200 OK

{
  "vasps": [
    {
      "health": "DOWN",
      "vaspId": "27372039731940770",
      "vaspName": "A Exchange",
      "legalName": "A Exchange",
      "jurisdiction": "Singapore",
      "isAlliance": true,
      "country": "Singapore",
      "licensedStatus": "Processing",
      "vaspStatus": "VERIFIED-MEMBER",
      "createdAt": "2021-09-27T01:48:38.000Z",
      "updatedAt": "2021-11-09T07:31:54.000Z"
    },
    {
      "health": "UP",
      "vaspId": "27372039731940165",
      "vaspName": "B Exchange",
      "legalName": "B Exchange",
      "jurisdiction": "Korea",
      "isAlliance": true,
      "country": "Korea",
      "licensedStatus": null,
      "vaspStatus": "VERIFIED-MEMBER",
      "createdAt": "2021-09-27T01:48:38.000Z",
      "updatedAt": "2022-01-13T15:27:50.000Z"
    }
  ]
}

Payload

Field Name
Data Type
Required
Description

vasps

object

true

VASP Information

vasps.health

string

true

The health status of the VASP Enclave server

vasps.vaspId

string

true

VASP ID

vasps.vaspName

string

true

VASP Name/ Business Name

vasps.legalName

string

false

VASP Legal Name

vasps.jurisdiction

string

false

Jurisdiction of Incorporation (country or region)

vasps.isAlliance

boolean

false

VerifyVASP alliance or not

vasps.country

string

false

Country

vasps.licensedStatus

string

false

Status of the VA License

vasps.vaspStatus

string

true

VASP status on VerifyVASP. See explanation below.

vasps.createdAt

Date

true

The time at which VASP information was created. UTC ISO 8601 format.

vasps.updatedAt

Date

true

The time at which VASP information was updated. UTC ISO 8601 format.

  • In vasps.vaspStatus field, values as below can be used.

    • One of “VERIFIED-MEMBER”, ”VERIFIED” and ”UNVERIFIED” values.

    • UNVERIFIED: Not registered yet.

    • VERIFIED: Registered but still waiting to be approved as an alliance. Or, approved as an alliance but have not installed the enclave server yet.

    • VERIFIED-MEMBER: Alliance whose enclave server is running normally and transactions are available.

PreviousVASP IDNextScreening API

Last updated 1 year ago