Addresses

Search for an address

Search addresses

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

formatinteger · nullableOptional

Mask of applied formatters for accounts

cursorstring · nullableOptional

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

uidstring · uuid · nullableOptional

Filter by internal address uid

externalIdstring · min: 1 · nullableOptional

Filter by external address id

ownerTypestring · enum · nullableOptional

Filter by address owner type

Possible values:

ownerUidstring · uuid · nullableOptional

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

associatedCounterpartyUidstring · uuid · nullableOptional

Filter by counterparty identifier with which address is associated

includeNullAssociatedCounterpartybooleanOptional

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

Default: false

networkstring · min: 1 · nullableOptional

Filter by network that serves wallet

currencystring · min: 1 · nullableOptional

Filter by currency or coin for which address is used

assetUidstring · nullableOptional

Filter by asset identifier for which address is used

accountstring · min: 1 · nullableOptional

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

directionstring · enum · nullableOptional

Filter by purpose of using address

Possible values:

statestring · enum · nullableOptional

Filter by address state

Possible values:

isActiveboolean · nullableOptional

Filter by active/inactive addresses

isHiddenboolean · nullableOptional

Filter by hidden/visible addresses

tagsstring[]Optional

Filter by address text labels

reportDetailstring · enum · nullableOptional

With what detail to return reports by addresses

Possible values:

Responses

200

Successful Response

application/json

nextstring · nullableRequired

Pointer to next page

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Validation Error

application/json

get/api/v1/addresses

HTTPcURLJavaScriptPython

GET /api/v1/addresses HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
      "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"
}

Adding address to address book

Adding an address to address book

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

externalIdstring · min: 1 · nullableOptional

External address ID

accountstring · min: 1Required

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsOptional

Additional account details

networkstring · min: 1Required

Network that serves wallet

currencystring · min: 1 · nullableOptional

Currency or coin for which address is used

directionstring · enumOptionalPossible values:

ownerTypestring · enumRequiredPossible values:

ownerUidstring · uuidRequired

Address owner identifier

descriptionstring · min: 1 · nullableOptional

Address explanation

associatedCounterpartyUidstring · uuid · nullableOptional

Counterparty identifier with which address is associated

isHiddenbooleanOptional

Address is hidden or visible

Default: false

tagsstring[]Optional

Address text labels

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Validation Error

application/json

post/api/v1/addresses

HTTPcURLJavaScriptPython

POST /api/v1/addresses HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "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"
  ]
}

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Approve address by internal UID

Approve address by internal UID

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

address_uidstring · uuidRequired

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

POST /api/v1/addresses/{address_uid}/approve HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Approve address by external ID

Approve address by external ID

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

external_idstringRequired

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

POST /api/v1/addresses/ext/{external_id}/approve HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Get an address by internal UID

Get address by internal UID

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

address_uidstring · uuidRequired

Query parameters

formatinteger · nullableOptional

Mask of applied formatters for accounts

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

get/api/v1/addresses/{address_uid}

HTTPcURLJavaScriptPython

GET /api/v1/addresses/{address_uid} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Deactivate address by internal UID

delete

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

address_uidstring · uuidRequired

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

delete/api/v1/addresses/{address_uid}

HTTPcURLJavaScriptPython

DELETE /api/v1/addresses/{address_uid} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Update address info by internal UID

patch

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

address_uidstring · uuidRequired

Body

application/json

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

patch/api/v1/addresses/{address_uid}

HTTPcURLJavaScriptPython

PATCH /api/v1/addresses/{address_uid} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "externalId": {
    "value": "text"
  },
  "description": {
    "value": "text"
  },
  "isHidden": {
    "value": true
  },
  "tags": {
    "value": [
      "text"
    ]
  }
}

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Get address by external ID

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

external_idstringRequired

Query parameters

formatinteger · nullableOptional

Mask of applied formatters for accounts

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

GET /api/v1/addresses/ext/{external_id} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Deactivate address by external ID

delete

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

external_idstringRequired

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

DELETE /api/v1/addresses/ext/{external_id} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Update address info by external ID

patch

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

external_idstringRequired

Body

application/json

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

PATCH /api/v1/addresses/ext/{external_id} HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "externalId": {
    "value": "text"
  },
  "description": {
    "value": "text"
  },
  "isHidden": {
    "value": true
  },
  "tags": {
    "value": [
      "text"
    ]
  }
}

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Verify address by internal UID

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

address_uidstring · uuidRequired

Body

application/json

verificationReasonone ofRequired

or

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

POST /api/v1/addresses/{address_uid}/verify HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "verificationReason": {
    "method": null,
    "txHash": "text"
  }
}

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}

Verify address by external ID

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

external_idstringRequired

Body

application/json

verificationReasonone ofRequired

or

Responses

200

Successful Response

application/json

uidstring · uuidRequired

Internal address uid

accountstringRequired

Banking IBAN or crypto wallet address

accountDetailsobject · AccountdetailsRequired

Additional account details

networkstringRequired

Network that serves wallet

currencystring · nullableRequired

Currency or coin for which address is used

assetUidstring · uuid · nullableRequired

Asset identifier for which address is used

directionstring · enumRequiredPossible values:

statestring · enumRequiredPossible values:

descriptionstring · nullableRequired

Address explanation

createdAtstring · date-timeRequired

Datetime the address was added

externalIdstring · nullableRequired

External address id

associatedCounterpartyUidstring · uuid · nullableRequired

Counterparty identifier with which address is associated

isActivebooleanRequired

Address is active or inactive

isHiddenbooleanRequired

Address is hidden or visible

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Address not found

application/json

422

Validation Error

application/json

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

HTTPcURLJavaScriptPython

POST /api/v1/addresses/ext/{external_id}/verify HTTP/1.1
Host: api.finchguard.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "verificationReason": {
    "method": null,
    "txHash": "text"
  }
}

{
  "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": "2026-07-13T17:45:15.644Z",
  "externalId": "text",
  "associatedCounterpartyUid": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "isHidden": true,
  "report": {
    "highRisk": true,
    "provider": "text",
    "riskScore": 1,
    "rawReport": {}
  }
}