Addresses

PreviousTransactions

Last updated 1 year ago

Adding an address to address book

post

/api/v1/addresses

Authorizations

Body

externalIdany of

External address ID

accountstring · min: 1required

Banking IBAN or crypto wallet address

accountDetailsobject

Additional account details

networkstring · min: 1required

Network that serves wallet

currencyany of

Currency or coin for which address is used

directionall of · default: all

Purpose of using address

ownerTypeall ofrequired

Address owner type

ownerUidstring · uuidrequired

Address owner identifier

descriptionany of

Address explanation

associatedCounterpartyUidany of

Counterparty identifier with which address is associated

isHiddenboolean · default: false

Address is hidden or visible

tagsstring[]

Address text labels

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.finchguard.com//api/v1/addresses' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": "text",
    "account": "text",
    "accountDetails": {},
    "network": "text",
    "currency": "text",
    "direction": "all",
    "ownerType": "self",
    "ownerUid": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
    "isHidden": false,
    "tags": [
      "text"
    ]
  }'

200

400

401

403

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Approve address by internal UID

post

/api/v1/addresses/{address_uid}/approve

Authorizations

Path parameters

address_uidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.finchguard.com//api/v1/addresses/{address_uid}/approve' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Approve address by external ID

post

/api/v1/addresses/ext/{external_id}/approve

Authorizations

Path parameters

external_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.finchguard.com//api/v1/addresses/ext/{external_id}/approve' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Get address by internal UID

get

/api/v1/addresses/{address_uid}

Authorizations

Path parameters

address_uidstring · uuidrequired

Query parameters

formatany of

Mask of applied formatters for accounts

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.finchguard.com//api/v1/addresses/{address_uid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Deactivate address by internal UID

delete

/api/v1/addresses/{address_uid}

Authorizations

Path parameters

address_uidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.finchguard.com//api/v1/addresses/{address_uid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Update address info by internal UID

patch

/api/v1/addresses/{address_uid}

Authorizations

Path parameters

address_uidstring · uuidrequired

Body

externalIdany of

New external address ID

descriptionany of

New address explanation

isHiddenany of

Set address hidden or visible flag

tagsany of

New address text labels

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.finchguard.com//api/v1/addresses/{address_uid}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": {
      "value": "text"
    },
    "description": {
      "value": "text"
    },
    "isHidden": {
      "value": true
    },
    "tags": {
      "value": [
        "text"
      ]
    }
  }'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Get address by external ID

get

/api/v1/addresses/ext/{external_id}

Authorizations

Path parameters

external_idstringrequired

Query parameters

formatany of

Mask of applied formatters for accounts

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.finchguard.com//api/v1/addresses/ext/{external_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Deactivate address by external ID

delete

/api/v1/addresses/ext/{external_id}

Authorizations

Path parameters

external_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.finchguard.com//api/v1/addresses/ext/{external_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Update address info by external ID

patch

/api/v1/addresses/ext/{external_id}

Authorizations

Path parameters

external_idstringrequired

Body

externalIdany of

New external address ID

descriptionany of

New address explanation

isHiddenany of

Set address hidden or visible flag

tagsany of

New address text labels

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.finchguard.com//api/v1/addresses/ext/{external_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalId": {
      "value": "text"
    },
    "description": {
      "value": "text"
    },
    "isHidden": {
      "value": true
    },
    "tags": {
      "value": [
        "text"
      ]
    }
  }'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Verify address by internal UID

post

/api/v1/addresses/{address_uid}/verify

Authorizations

Path parameters

address_uidstring · uuidrequired

Body

verificationReasonone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.finchguard.com//api/v1/addresses/{address_uid}/verify' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "verificationReason": {
      "method": null,
      "txHash": "text"
    }
  }'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Verify address by external ID

post

/api/v1/addresses/ext/{external_id}/verify

Authorizations

Path parameters

external_idstringrequired

Body

verificationReasonone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.finchguard.com//api/v1/addresses/ext/{external_id}/verify' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "verificationReason": {
      "method": null,
      "txHash": "text"
    }
  }'

200

400

401

403

404

422

{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "account": "text",
  "accountDetails": {},
  "network": "text",
  "currency": "text",
  "assetUid": "123e4567-e89b-12d3-a456-426614174000",
  "direction": "deposit",
  "state": "ownershipPending",
  "description": "text",
  "createdAt": "2025-03-13T16:45:12.894Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Successful Response

Search addresses

get

/api/v1/addresses

Authorizations

Query parameters

formatany of

Mask of applied formatters for accounts

cursorany of

Pointer to next data chunk. Contains filters from first request that override passed filters.

uidany of

Filter by internal address uid

externalIdany of

Filter by external address id

ownerTypeany of

Filter by address owner type

ownerUidany of

Filter by address owner identifier ('ownerType' is required)

associatedCounterpartyUidany of

Filter by counterparty identifier with which address is associated

includeNullAssociatedCounterpartyboolean · default: false

Whether to include addresses without associated counterparty (used only when filtering by associatedCounterpartyUid)

networkany of

Filter by network that serves wallet

currencyany of

Filter by currency or coin for which address is used

assetUidany of

Filter by asset identifier for which address is used

accountany of

Filter by banking IBAN or crypto wallet address ('network' is required)

directionany of

Filter by purpose of using address

stateany of

Filter by address state

isActiveany of

Filter by active/inactive addresses

isHiddenany of

Filter by hidden/visible addresses

tagsstring[]

Filter by address text labels

reportDetailany of

With what detail to return reports by addresses

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.finchguard.com//api/v1/addresses' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

422

{
  "items": [
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "account": "text",
      "accountDetails": {},
      "network": "text",
      "currency": "text",
      "assetUid": "123e4567-e89b-12d3-a456-426614174000",
      "direction": "deposit",
      "state": "ownershipPending",
      "description": "text",
      "createdAt": "2025-03-13T16:45:12.894Z",
      "externalId": "text",
      "ownerType": "self",
      "ownerUid": "123e4567-e89b-12d3-a456-426614174000",
      "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
      "verificationReason": {},
      "isActive": true,
      "isHidden": true,
      "report": {
        "highRisk": true,
        "provider": "text",
        "riskScore": 1,
        "rawReport": {}
      }
    }
  ],
  "next": "text"
}

Successful Response

Addresses

Addresses

Search for an address

Adding address to address book

Approve address by internal UID

Approve address by external ID

Get an address by internal UID

Search for an address

Adding address to address book

Approve address by internal UID

Approve address by external ID

Get an address by internal UID

Adding an address to address book

Approve address by internal UID

Approve address by external ID

Get address by internal UID

Deactivate address by internal UID

Update address info by internal UID

Get address by external ID

Deactivate address by external ID

Update address info by external ID

Verify address by internal UID

Verify address by external ID

Search addresses

Search for an address

Adding address to address book

Approve address by internal UID

Approve address by external ID

Get an address by internal UID

Search for an address

Adding address to address book

Approve address by internal UID

Approve address by external ID

Get an address by internal UID

Adding an address to address book

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show AddressDirection

Show OwnerType

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Approve address by internal UID

Approve address by external ID

Get address by internal UID

Show child attributes

Show child attributes

Deactivate address by internal UID

Update address info by internal UID

Show ChangedValue[Union[str, NoneType]]

Show child attributes

Show ChangedValue[Union[str, NoneType]]

Show child attributes

Show ChangedValue[bool]

Show child attributes

Show ChangedValue[list[str]]

Show child attributes

Get address by external ID

Show child attributes

Show child attributes

Deactivate address by external ID

Update address info by external ID

Show ChangedValue[Union[str, NoneType]]

Show child attributes

Show ChangedValue[Union[str, NoneType]]

Show child attributes

Show ChangedValue[bool]

Show child attributes

Show ChangedValue[list[str]]

Show child attributes

Verify address by internal UID

Show ReceiveSatoshiVerification

Show Web3SignatureVerification

Verify address by external ID

Show ReceiveSatoshiVerification

Show Web3SignatureVerification

Search addresses

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show OwnerType

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show AddressDirection

Show child attributes