What is known about an address before you pay it

GET

/v1/addresses/{address}

const url = 'https://api.sotirea.com/v1/addresses/example?network=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.sotirea.com/v1/addresses/example?network=example' \
  --header 'Authorization: Bearer <token>'

Reads what your payment rules will read about an address on one network, without sending anything: whether it is a valid address, whether your organisation has paid it before, whether it is approved and from when it may be paid, whether it looks like an address you have paid or approved without being it, and whether it is a contract. Show it to the person about to pay.

Authorizations

bearer

Parameters

Path Parameters

address

required

string

The address, as it was given to you.

Query Parameters

network

required

string

The network, by its CAIP-2 id, like eip155:1.

Responses

200

Done.

application/json

object

data

required

object

address

required

The address, in lower case when it is valid.

string

approved

required

Whether it is on your organisation’s approved list.

boolean

chain_id

required

string

holds_code

required

Whether the address is a contract on this network.

boolean

listed

required

Whether a sanctions list or Sotirea’s blocked list names it: a payment to it is refused.

boolean

lookalike_of

required

Any of:

object
null

object

address

required

string

kind

required

Paid: an address you have paid; approved: one on your approved list.

string

paid_before

required

Whether your organisation has completed a payment to it on this network.

boolean

payable_from

required

Any of:

string
null

string format: date-time

problem

Why it is not valid, in words; absent when it is.

string

valid

required

Whether it is an address: 0x and 40 hexadecimal characters, with a correct EIP-55 checksum when its letters are mixed in case.

boolean

meta

object

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

application/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}