Skip to main content
POST
Connect provider
Do not send auth_method. Credentials are never returned. For a hosted setup, complete the returned authorization attempt before it expires. Then use List connections to confirm the connection and get its connection_ids and source_ids. To reauthorize a general-ledger connection, call this operation again.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Headers

Idempotency-Key
string
required

Unique key for this operation. Retry with the same key and request body after a timeout. Keys are retained for at least 24 hours.

Required string length: 1 - 255

Body

application/json

An exchange venue. Credentials are supplied inline; there is no hosted setup for an exchange.

provider
string
required

The exchange venue in lower case, such as kraken or binance. For QuickBooks, Xero, NetSuite, Campfire and DualEntry, use the general-ledger request body.

Example:

"kraken"

name
string
required

Display name. Required for an exchange connection.

Required string length: 1 - 500

Exactly one legal entity. An exchange connection scopes to a single entity.

Required array length: 1 element

Legal entity ID (le_…).

api_key
string
required

Venue API key.

Minimum string length: 1
api_secret
string
required

Venue API secret.

Minimum string length: 1
api_passphrase
string

Venue API passphrase. Required for coinbase, coinbase_exchange, coinbase_prime, coinbase_international and kucoin; omitting it there fails with 400.

Minimum string length: 1
return_url
string<uri>

Registered HTTPS dashboard URL to return to after hosted setup.

Example:

"https://app.entendre.finance/settings/integrations"

Response

OAuth consent URL for a hosted GL provider (data.redirect_url).

data
object
required

The connection.