Check Address Validity
POST/frontoffice/api/v1/travel/address
Verifies whether the provided wallet address is associated with PingExchange or not.
- Before using this API, providers must submit their profile to PingExchange, including the Virtual Asset Service Provider's name (VASP) and a secret key. The VASP's name will be referred to as the vaspId. Based on
RFC #2104 section.3
and alsoRFC #4848 page.5
, key needs to be chosen at random (or using a cryptographically strong pseudo-random generator seeded with a random seed). This key is required byHMAC
cryptography mechanism. - To comply with the
FATF Travel Rule
verify if a wallet address is linked to PingExchange, a call to the following API is necessary.
Request
Header Parameters
- Please be aware that currently, we exclusively offer support for
HMAC256
. - Generated hash value should be in
Hex
format.
The applicant should encrypt the wallet address using the HMAC256
encryption algorithm with the designated key, and place the resulting encrypted address in the request header.
- application/json-patch+json
- application/json
- text/json
- application/*+json
Body
required
Contains VASPId, WalletAddress and AssetId parameters.
-
All properties are required and must be sent.
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The Virtual Asset Provider
identifier (required)
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The address of the wallet that requires verification to determine if it is associated with PingExchange (required)
Possible values: >= 3 characters
and <= 4 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The ID of the asset associated with the wallet such as ctn, xcb, btn etc. (required)
Body
required
Contains VASPId, WalletAddress and AssetId parameters.
-
All properties are required and must be sent.
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The Virtual Asset Provider
identifier (required)
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The address of the wallet that requires verification to determine if it is associated with PingExchange (required)
Possible values: >= 3 characters
and <= 4 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The ID of the asset associated with the wallet such as ctn, xcb, btn etc. (required)
Body
required
Contains VASPId, WalletAddress and AssetId parameters.
-
All properties are required and must be sent.
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The Virtual Asset Provider
identifier (required)
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The address of the wallet that requires verification to determine if it is associated with PingExchange (required)
Possible values: >= 3 characters
and <= 4 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The ID of the asset associated with the wallet such as ctn, xcb, btn etc. (required)
Body
required
Contains VASPId, WalletAddress and AssetId parameters.
-
All properties are required and must be sent.
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The Virtual Asset Provider
identifier (required)
Possible values: >= 3 characters
and <= 256 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The address of the wallet that requires verification to determine if it is associated with PingExchange (required)
Possible values: >= 3 characters
and <= 4 characters
, Value must match regular expression ^[a-zA-Z0-9]*$
The ID of the asset associated with the wallet such as ctn, xcb, btn etc. (required)
Responses
- 200
- 404
Success
Not Found