Skip to main content

Validate wallet address

POST /v1/validate-address

Check if the given wallet or refund address and (optional) extra ID are valid for the given currency.

HTTP request

https://fiat-api.changelly.com/v1/validate-address

Request

Header parameters

NameTypeRequiredDescription
X-Api-KeystringtrueYour public API key.
X-Api-SignaturestringtrueThe query's serialized body signed by your private key according to the RSA-SHA256 method.

Body parameters

NameTypeRequiredDescription
currencystringtrueCryptocurrency ticker (in uppercase).
walletAddressstringtrueRecipient wallet address.
walletExtraIdstringfalseProperty required for wallet addresses of currencies that use an additional ID for transaction processing (XRP, XLM, EOS, BNB).

Response

Sample response

application/json
{
"result": false,
"cause": "walletExtraId"
}

Response params

NameTypeRequiredDescription
resultbooleantruefalse if the wallet address or extra ID is incorrect.
causestringtrueEnum: walletAddress walletExtraId.
Specifies whether the wallet address or extra ID is incorrect.
If result is true, cause is null.

Error schema

NameTypeRequiredDescription
errorTypestringtrueError type.
errorMessagestringtrueError message.
errorDetailsarray of objectstrueIf the error contains no details, errorDetails equals null.

Possible error types:

TypeDescription
validationValidation error.

errorDetails item schema

NameTypeRequiredDescription
causestringtrueError cause. For example, it can equal the missing request parameter for the validation error type.
valuestringtrueError value.

Error codes

CodeMessage
400BadRequest
401Unauthorized
429TooManyRequests
500InternalServerError
BadRequest
{
"errorType": "validation",
"errorMessage": "Validation error",
"errorDetails": [
{
"cause": "currency",
"value": "Incorrect currency"
}
]
}