Addresses

Search for an address

Search addresses

GEThttps://api.finchguard.com//api/v1/addresses

Authorization

Authorization

Query parameters

Response

200400401403422

Successful Response

Body

application/json

items*Items

next*Next

Pointer to next page

stringnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "items": [
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "account": "text",
      "network": "text",
      "currency": "text",
      "assetUid": "123e4567-e89b-12d3-a456-426614174000",
      "direction": {},
      "state": {},
      "description": "text",
      "createdAt": "2024-05-19T17:23:05.600Z",
      "externalId": "text",
      "ownerType": {},
      "ownerUid": "123e4567-e89b-12d3-a456-426614174000",
      "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
      "isActive": false,
      "isHidden": false,
      "report": {
        "highRisk": false,
        "provider": "text",
        "riskScore": 0
      }
    }
  ],
  "next": "text"
}

Adding address to address book

Adding an address to address book

POSThttps://api.finchguard.com//api/v1/addresses

Authorization

Authorization

Body

application/json

externalIdExternalid

External address ID

stringnull

account*Account

Banking IBAN or crypto wallet address

accountDetailsAccountdetails

Additional account details

network*Network

Network that serves wallet

currencyCurrency

Currency or coin for which address is used

stringnull

directionall of

Purpose of using address

ownerType*all of

Address owner type

ownerUid*Owneruid

Address owner identifier

descriptionDescription

Address explanation

stringnull

associatedCounterpartyUidAssociatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isHiddenIshidden

Address is hidden or visible

tagsTags

Address text labels

Response

200400401403422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "text",
      "network": "text",
      "ownerType": {},
      "ownerUid": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Approve address by internal UID

Approve address by internal UID

POSThttps://api.finchguard.com//api/v1/addresses/{address_uid}/approve

Authorization

Authorization

Path parameters

address_uid*Address Uid

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/{address_uid}/approve', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Approve address by external ID

Approve address by external ID

POSThttps://api.finchguard.com//api/v1/addresses/ext/{external_id}/approve

Authorization

Authorization

Path parameters

external_id*External Id

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/ext/{external_id}/approve', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Get an address by internal UID

Get address by internal UID

GEThttps://api.finchguard.com//api/v1/addresses/{address_uid}

Authorization

Authorization

Path parameters

address_uid*Address Uid

Query parameters

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/{address_uid}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Deactivate address by internal UID

DELETEhttps://api.finchguard.com//api/v1/addresses/{address_uid}

Authorization

Authorization

Path parameters

address_uid*Address Uid

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/{address_uid}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Update address info by internal UID

PATCHhttps://api.finchguard.com//api/v1/addresses/{address_uid}

Authorization

Authorization

Path parameters

address_uid*Address Uid

Body

application/json

externalIdany of

New external address ID

ChangedValue[Union[str, NoneType]]null

descriptionany of

New address explanation

ChangedValue[Union[str, NoneType]]null

isHiddenany of

Set address hidden or visible flag

ChangedValue[bool]null

tagsany of

New address text labels

ChangedValue[list[str]]null

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/{address_uid}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Get address by external ID

GEThttps://api.finchguard.com//api/v1/addresses/ext/{external_id}

Authorization

Authorization

Path parameters

external_id*External Id

Query parameters

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/ext/{external_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Deactivate address by external ID

DELETEhttps://api.finchguard.com//api/v1/addresses/ext/{external_id}

Authorization

Authorization

Path parameters

external_id*External Id

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/ext/{external_id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Update address info by external ID

PATCHhttps://api.finchguard.com//api/v1/addresses/ext/{external_id}

Authorization

Authorization

Path parameters

external_id*External Id

Body

application/json

externalIdany of

New external address ID

ChangedValue[Union[str, NoneType]]null

descriptionany of

New address explanation

ChangedValue[Union[str, NoneType]]null

isHiddenany of

Set address hidden or visible flag

ChangedValue[bool]null

tagsany of

New address text labels

ChangedValue[list[str]]null

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/ext/{external_id}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Verify address by internal UID

POSThttps://api.finchguard.com//api/v1/addresses/{address_uid}/verify

Authorization

Authorization

Path parameters

address_uid*Address Uid

Body

application/json

verificationReason*Verificationreason

ReceiveSatoshiVerificationWeb3SignatureVerification

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/{address_uid}/verify', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "verificationReason": {
        "txHash": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}

Verify address by external ID

POSThttps://api.finchguard.com//api/v1/addresses/ext/{external_id}/verify

Authorization

Authorization

Path parameters

external_id*External Id

Body

application/json

verificationReason*Verificationreason

ReceiveSatoshiVerificationWeb3SignatureVerification

Response

200400401403404422

Successful Response

Body

application/json

uid*Uid

Internal address uid

account*Account

Banking IBAN or crypto wallet address

accountDetails*Accountdetails

Additional account details

network*Network

Network that serves wallet

currency*Currency

Currency or coin for which address is used

stringnull

assetUid*Assetuid

Asset identifier for which address is used

string (uuid)null

direction*all of

Purpose of using address

state*all of

Address state

description*Description

Address explanation

stringnull

createdAt*Createdat

Datetime the address was added

externalId*Externalid

External address id

stringnull

associatedCounterpartyUid*Associatedcounterpartyuid

Counterparty identifier with which address is associated

string (uuid)null

isActive*Isactive

Address is active or inactive

isHidden*Ishidden

Address is hidden or visible

report*any of

Address analysis report

AddressAnalysisReportnull

Request

JavaScriptCurl

const response = await fetch('https://api.finchguard.com//api/v1/addresses/ext/{external_id}/verify', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "verificationReason": {
        "txHash": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": {},
  "state": {},
  "description": "text",
  "createdAt": "2024-05-19T17:23:05.600Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": false,
  "isHidden": false,
  "report": {
    "highRisk": false,
    "provider": "text",
    "riskScore": 0
  }
}