IDCanopy Developers

Authentication

Token exchange for Umbrella API, and the header for Aletheia

IDCanopy portal: Sign in to the portal: coming soon. Your API keys will be viewable and rotatable there. Until then, contact office@idcanopy.com.

Umbrella API: token exchange

Exchange credentials on your backend
Exchange credentials on your backendYour backend to IDCanopy API: POST /auth with Api-Key and Customer-Id headers. IDCanopy API to Your backend: Return access_token and expires_in. Your backend to IDCanopy API: Call an operation with Authorization: Bearer <token>. IDCanopy API to Your backend: Return the operation resultYour backendIDCanopy API1. POST /auth with Api-Key and Customer-Id headers2. Return access_token and expires_in3. Call an operation with Authorization: Bearer <token>4. Return the operation result

Keep API credentials and bearer tokens on the backend, not in browser code. Re-authenticate before expiry; there is no refresh-token flow. Aletheia uses its issued key directly and does not use this exchange.

POST /auth (base URL: see Environments) with your key in headers, not in the body:

curl -X POST "$UMBRELLA_BASE_URL/auth" \
  -H "Api-Key: $UMBRELLA_API_KEY" \
  -H "Customer-Id: $UMBRELLA_CUSTOMER_ID" \
  -H "Content-Type: application/x-www-form-urlencoded"

Response:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

expires_in is in seconds (3600 = 1 hour). Use the token as Authorization: Bearer <access_token> on every subsequent Umbrella API call. Re-authenticate before it expires; there is no refresh-token flow.

Aletheia (forensic scoring)

No token exchange. Use your issued key directly:

curl "$ALETHEIA_BASE_URL/..." \
  -H "Authorization: Bearer $ALETHEIA_API_KEY"

IBAN Validation and Address Autocomplete are part of Umbrella API and use the same bearer token. AutoKYB: pending.

On this page