Skip to main content
POST
/
api
/
v0
/
application
/
connect
Connect user
curl --request POST \
  --url https://dev.bringin.xyz/api/v0/application/connect \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "email": "<string>",
  "callback": "<string>",
  "ref": "<string>",
  "direction": "<string>",
  "btcAddress": "<string>",
  "iban": "<string>",
  "bic": "<string>",
  "beneficiaryName": "<string>",
  "lnAddress": "<string>",
  "currency": "<string>",
  "network": "<string>"
}
'
{
  "status": "connected",
  "userRegistered": true,
  "isUserConnected": true,
  "apiKey": "NzY1YWQzZGYwNTE4NDQ4NzkxMTcxMTIxYzVmY2NlMDI="
}
Initiate a connection between a user and your application. This is how you get a per-user api-key. Requires your master api-key. HMAC signing required if callback is provided.
​
email
string
required
The user’s email address
​
callback
string
Webhook URL where we send the api-key and status updates. Requires HMAC.
​
ref
string
Your internal user ID. Returned in all webhooks so you can match them.
​
direction
string
FIAT_TO_CRYPTO or CRYPTO_TO_FIAT. Pass this to create a connection in the same call.
​
btcAddress
string
BTC address (26-90 chars). Required if direction is FIAT_TO_CRYPTO.
​
iban
string
Valid IBAN. Required if direction is CRYPTO_TO_FIAT.
​
bic
string
BIC/SWIFT code (8-11 chars).
​
beneficiaryName
string
Account holder name (2-100 chars).
​
lnAddress
string
Lightning address for LN sell connections.
​
currency
string
BTC, ETH, USDC, or USDT. Default: BTC.
​
network
string
Blockchain network. Default: BTC.
{
  "status": "connected",
  "userRegistered": true,
  "isUserConnected": true,
  "apiKey": "NzY1YWQzZGYwNTE4NDQ4NzkxMTcxMTIxYzVmY2NlMDI="
}