Get VASP details

Get VASP Details.

Returns information about a VASP that has the specified DID.

GET /screening/travel_rule/vasp/{did}

TypeScript

TypeScript

const response: Promise<FireblocksResponse<TravelRuleVASP>> = fireblocks.travelRule.getVASPByDID(travelRuleApiGetVASPByDIDRequest);

200

{
  "did": "did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6",
  "name": "Fireblocks TST",
  "verificationStatus": "VERIFIED",
  "addressLine1": "657 Campfire Street",
  "city": "New York",
  "country": "US",
  "emailDomains": "fireblocks.com,example.com",
  "website": "https://fireblocks.com",
  "legalStructure": "CORPORATION",
  "legalName": "Fireblocks Inc.",
  "yearFounded": "2019",
  "incorporationCountry": "US",
  "isRegulated": "YES",
  "jurisdictions": "US, EU",
  "travelRule_TRLIGHT": "active",
  "createdAt": "2023-09-19T12:23:59.711Z",
  "hasAdmin": true,
  "isNotifiable": true,
  "issuers": {
    "yearFounded": {
      "issuerDid": "<string>"
    },
    "isRegulated": {
      "issuerDid": "<string>"
    },
    "regulatoryAuthorities": {
      "issuerDid": "<string>"
    },
    "name": {
      "issuerDid": "<string>"
    },
    "logo": {
      "issuerDid": "<string>"
    },
    "website": {
      "issuerDid": "<string>"
    },
    "legalName": {
      "issuerDid": "<string>"
    },
    "legalStructure": {
      "issuerDid": "<string>"
    },
    "incorporationCountry": {
      "issuerDid": "<string>"
    },
    "businessNumber": {
      "issuerDid": "<string>"
    },
    "addressLine1": {
      "issuerDid": "<string>"
    },
    "city": {
      "issuerDid": "<string>"
    },
    "country": {
      "issuerDid": "<string>"
    },
    "description": {
      "issuerDid": "<string>"
    }
  },
  "addressLine2": "Suite 10",
  "logo": "https://fireblocks.com/logo.png",
  "otherNames": "Fireblocks Test VASP",
  "identificationType": "Business License",
  "identificationCountry": "US",
  "businessNumber": "123456789",
  "regulatoryAuthorities": "SEC, FINCEN",
  "street": "Wall Street",
  "number": "10",
  "unit": "Apt 2B",
  "postCode": "10005",
  "state": "NY",
  "certificates": "ISO 27001",
  "description": "A leading provider of crypto security solutions.",
  "travelRule_OPENVASP": "active",
  "travelRule_SYGNA": "inactive",
  "travelRule_TRISA": "pending",
  "travelRule_EMAIL": "inactive",
  "travelRule_TRP": "active",
  "travelRule_SHYFT": "inactive",
  "travelRule_USTRAVELRULEWG": "pending",
  "createdBy": "admin",
  "updatedAt": "2024-08-29T08:23:51.416Z",
  "updatedBy": "system",
  "lastSentDate": "2024-03-18T09:26:07.988Z",
  "lastReceivedDate": "2024-03-20T11:45:30.212Z",
  "documents": "['license.pdf', 'compliance.pdf']"
}

Path Parameters

did · string · required

Query Parameters

fields · enum<string>[]

A CSV of fields to return. Choose from the following options:

Available options: did, name, verificationStatus, addressLine1, addressLine2, city, country, emailDomains, website, logo, legalStructure, legalName, yearFounded, incorporationCountry, isRegulated, otherNames, identificationType, identificationCountry, businessNumber, regulatoryAuthorities, jurisdictions, street, number, unit, postCode, state, certificates, description, travelRule_OPENVASP, travelRule_SYGNA, travelRule_TRISA, travelRule_TRLIGHT, travelRule_EMAIL, travelRule_TRP, travelRule_SHYFT, travelRule_USTRAVELRULEWG, createdAt, createdBy, updatedAt, updatedBy, lastSentDate, lastReceivedDate, documents, hasAdmin, isNotifiable, issuers

Example:

["name", "country", "website"]

Response

200

application/json

Transaction validated successfully

did · string · required

The Decentralized Identifier (DID) of the VASP.

Example:

"did:ethr:0x17fe2dd11a2daa7f6c1fdf22532a4763f963aea6"

name · string · required

The name of the VASP.

Example:

"Fireblocks TST"

verificationStatus · string · required

The current verification status of the VASP.

Example:

"VERIFIED"

addressLine1 · string · required

The first line of the VASP's address.

Example:

"657 Campfire Street"

city · string · required

The city where the VASP is located.

Example:

"New York"

country · string · required

The country where the VASP is registered (ISO-3166 Alpha-2 code).

Example:

"US"

emailDomains · string · required

Comma-separated list of email domains associated with the VASP.

Example:

"fireblocks.com,example.com"

website · string · required

The official website of the VASP.

Example:

"https://fireblocks.com"

legalStructure · string · required

The legal structure of the VASP (e.g., Corporation, LLC).

Example:

"CORPORATION"

legalName · string · required

The legal name of the VASP.

Example:

"Fireblocks Inc."

yearFounded · string · required

The year the VASP was founded.

Example:

"2019"

incorporationCountry · string · required

The country where the VASP is incorporated (ISO-3166 Alpha-2 code).

Example:

"US"

isRegulated · string · required

Indicates whether the VASP is regulated.

Example:

"YES"

jurisdictions · string · required

The jurisdictions where the VASP operates.

Example:

"US, EU"

travelRule_TRLIGHT · string · required

Travel rule compliance status for TRLight.

Example:

"active"

createdAt · string · required

Timestamp when the VASP record was created.

Example:

"2023-09-19T12:23:59.711Z"

hasAdmin · boolean · required

Indicates if the VASP has an admin.

Example:

true

isNotifiable · boolean · required

Indicates if the VASP is notifiable for compliance reasons.

Example:

true

issuers · object · required

Show child attributes

addressLine2 · string

The second line of the VASP's address (if applicable).

Example:

"Suite 10"

logo · string

URL to the logo of the VASP.

Example:

"https://fireblocks.com/logo.png"

otherNames · string

Other names the VASP is known by.

Example:

"Fireblocks Test VASP"

identificationType · string

The type of identification used by the VASP.

Example:

"Business License"

identificationCountry · string

The country of identification for the VASP (ISO-3166 Alpha-2 code).

Example:

"US"

businessNumber · string

The business registration number of the VASP.

Example:

"123456789"

regulatoryAuthorities · string

The regulatory authorities overseeing the VASP.

Example:

"SEC, FINCEN"

street · string

The street name where the VASP is located.

Example:

"Wall Street"

number · string

The building number of the VASP's address.

Example:

"10"

unit · string

The unit or suite number of the VASP's address.

Example:

"Apt 2B"

postCode · string

The postal code of the VASP's location.

Example:

"10005"

state · string

The state or region where the VASP is located.

Example:

"NY"

certificates · string

Certificates or licenses held by the VASP.

Example:

"ISO 27001"

description · string

A brief description of the VASP.

Example:

"A leading provider of crypto security solutions."

travelRule_OPENVASP · string

Travel rule compliance status for OpenVASP.

Example:

"active"

travelRule_SYGNA · string

Travel rule compliance status for Sygna.

Example:

"inactive"

travelRule_TRISA · string

Travel rule compliance status for TRISA.

Example:

"pending"

travelRule_EMAIL · string

Travel rule compliance status for EMAIL.

Example:

"inactive"

travelRule_TRP · string

Travel rule compliance status for TRP.

Example:

"active"

travelRule_SHYFT · string

Travel rule compliance status for Shyft.

Example:

"inactive"

travelRule_USTRAVELRULEWG · string

Travel rule compliance status for US Travel Rule WG.

Example:

"pending"

createdBy · string

User or system that created the VASP record.

Example:

"admin"

updatedAt · string

Timestamp of the last update to the VASP record.

Example:

"2024-08-29T08:23:51.416Z"

updatedBy · string

User or system that last updated the VASP record.

Example:

"system"

lastSentDate · string

The last date a transaction was sent by the VASP.

Example:

"2024-03-18T09:26:07.988Z"

lastReceivedDate · string

The last date a transaction was received by the VASP.

Example:

"2024-03-20T11:45:30.212Z"

documents · string

Documents associated with the VASP.

Example:

"['license.pdf', 'compliance.pdf']"