IDCanopy Developers

Introduction

Choose an IDCanopy product and prepare your integration

Choose how to integrate IDCanopy: call individual capabilities through the API, or combine them in hosted or embedded journeys. Aletheia and Poros also have their own documentation. See the platform overview, then continue to Authentication.

Products

  • IDCanopy API. Integrate KYC, KYB, Identity & Signing, Risk Intelligence, payments and address capabilities into your application. The gateway and contracts also use the name Umbrella API.
  • IDCanopy Workflows & UI. Integrate hosted or embedded journeys combining capabilities across families, including identification and signing.
  • Aletheia. Document forensics with a case API, findings and verdicts. Learn about Aletheia on IDCanopy.com.
  • Poros. Hosted, white-label merchant onboarding, live on demand: IDCanopy sets it up for you. Learn about Poros on IDCanopy.com.

Before you integrate

  1. Which header carries the key. It differs by service, see the table below.
  2. Sandbox and production are separate hosts with separate credentials. A sandbox key does not work against production and vice versa. See Environments for the host list.
  3. Where to get credentials. From your IDCanopy contact. Self-service signup is not available yet; contact office@idcanopy.com.

Authentication at a glance

ServiceHow the key travels
IDCanopy APIApi-Key + Customer-Id headers to POST /auth, which returns a bearer token. Use Authorization: Bearer <token> on every subsequent call.
Aletheia (forensic scoring)Authorization: Bearer <token> per tenant. No separate token-exchange call.
AutoKYBNot available yet. Contact office@idcanopy.com.

Full detail: Authentication.

Next

On this page