Which customer ID should I use?
Updated 2 weeks ago
Use your own stable internal tenant ID as the Unique Customer ID (origin_id) when you create a connector. Don't use a name or an email address. It's how you match a connector, and every webhook about it, back to the customer in your own database.
Rules for the Unique Customer ID
Unique within an integration. Two connectors for the same integration can't share an ID. Connecting a second tenant with an ID already in use for that integration fails.
Reusable across integrations. The same customer can keep the same ID on their HRIS connector and their payroll connector.
Never reused for another customer. If your tenant IDs can be reissued, for example sequential numbers that restart after a database reset, they'll clash with connectors you already have. Use an identifier that's permanent.
Where the Unique Customer ID appears
In the Unique Customer ID field when you create a Magic Link, and as
end_user_data.origin_idwhen you create an Embedded SDK link token.As
origin_idon every connector in Get Connectors, which you can also filter byorigin_id.As
connector.origin_idin every webhook payload.
The other IDs on a connector
ID | What it's for |
|---|---|
| Your customer ID. Use it to find the customer's connectors and route webhooks |
Connector | Our UUID for the connector. Use it with the Delete Connector API and when you contact support |
| The credential for reading and writing that customer's data. Send it as |
| The organization name you entered. It's the name shown on the connector, not an identifier |
Replacing a connector for the same customer
When a customer needs a connector for a different integration from the same provider, for example a separate payroll integration, create a new connector for it. You can keep the same Unique Customer ID because it's a different integration. The new connector's records get new Bindbee IDs, so remap anything you stored from the old one.