Address book

Get missing identity details

Get the details still needed before a wallet owner's declaration can be completed.

GET
/api/v2/counterparty-requests/identity

Returns the fields still needed before a wallet declaration naming your organization, one of your customers, or a saved person or business can be completed, checked against the details already held, verified identity-provider details and details you supplied on earlier declarations. Personal details already held are not returned, only the countries and identification types that decide which details are needed. Pass network and address to learn whether wallet custody is already known. Ask your users only for the missing details.

Query Parameters

party*string

Whose details to return. Case-insensitive.

Value in"ORGANIZATION" | "CUSTOMER" | "THIRD_PARTY"
customerId?string

Required when party is CUSTOMER.

Lengthlength <= 100
profileId?string

Required when party is THIRD_PARTY. An id from GET /api/v2/counterparty-requests/parties.

Lengthlength <= 100
network?string

Network of the wallet. Case-insensitive. Required together with address.

Value in"base" | "ethereum" | "arbitrum" | "solana" | "tron" | "polygon" | "avalanche" | "bitcoin" | "dogecoin" | "ripple" | "near" | "sui" | "ton"
address?string

Wallet address. Required together with network so custody already on file is not requested again.

Lengthlength <= 200

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://compose.finance/api/v2/counterparty-requests/identity?party=ORGANIZATION"
{
  "identityContext": {
    "kind": "INDIVIDUAL",
    "addressCountry": "CA",
    "identifications": [
      {
        "type": "2",
        "country": "CA"
      }
    ]
  },
  "missingFields": [
    "occupation",
    "identifications.0.region",
    "wallet.custody"
  ],
  "custodyKnown": false,
  "custodyRequired": true
}
{
  "error": "customerId: Required when party is CUSTOMER"
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}

{
  "error": "Customer not found in this organization"
}

{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}

{
  "error": "Verified identity is temporarily unavailable. Try again in a few minutes."
}