VASP List
get
http://<enclave-endpoint>
/v1/vasps
View the List of VASPs
This API returns the list of VASPs.When a withdrawal is requested to a VASP, the VASP can call this API to find the vaspId (ID of the VASP) of the other VASP.The list only includes the information of member VASPs of VerifyVASP alliance by default. If 'includesAll' field as true, a query parameter field, you can get the list of all the VASPs including non-alliance members.
Field Name | Data Type | Description | Example |
|---|---|---|---|
includesAll | boolean | A flag deciding whether to view only the alliances using VerifyVASP protocol or all VASPs. | false |
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.
Last modified 7mo ago