Link an account

{
  "contact": {
    "value": "user@example.com",
    "type": "email",
    "isVerified": true
  },
  "biltMemberId": "550e8400-e29b-41d4-a716-446655440000",
  "partnerMemberId": "PARTNER123456789",
  "idempotencyKey": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

{
  "status": "linked",
  "partnerMemberId": "PARTNER123456789"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "invalid_token",
  "error_description": "The access token is invalid"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Implement POST /bilt/link-account on your server. Bilt calls it with the request below.

Authorizations

Authorization

string

header

required

The credential you issue to Bilt for the endpoints you host. Validate it on every request, before you read the body, and keep it out of logs.

Body

application/json

contact

object

required

Show child attributes

biltMemberId

string<uuid>

required

The Bilt member id.

idempotencyKey

string<uuid>

required

Unique per link request, and the same on a retry. It is also the linkId of the link episode, the value POST /v1/account-links/unlink takes.

partnerMemberId

string

Your member id, usually from look up a contact. Use it only to choose between accounts; the account must still match the verified contact.

Response

The account is linked. Answer a retry of a link that landed the same way.

status

string

required

Allowed value: "linked"

partnerMemberId

string

required

⌘I

{
  "contact": {
    "value": "user@example.com",
    "type": "email",
    "isVerified": true
  },
  "biltMemberId": "550e8400-e29b-41d4-a716-446655440000",
  "partnerMemberId": "PARTNER123456789",
  "idempotencyKey": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

{
  "status": "linked",
  "partnerMemberId": "PARTNER123456789"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "invalid_token",
  "error_description": "The access token is invalid"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Overview

Endpoints you host

Account links API

Order reports API

Authorizations

Body

Response