API
Deprecated Resources
⚠️

This functionality is deprecated and will be removed in a future version of the API.

Endpoints (Deprecated)

ℹ️

Don't forget to get your Api Key from the Bits Dashboard.

Authenticating using API Keys (Deprecated)

All requests made on our API require authentication and correct authorization by passing an Authorization header with the value Bearer {token}. The token is an API key you need to generate in the Bits Technology Dashboard (opens in a new tab).

Example http request
GET /applications HTTP/1.1
 
Authorization: Bearer {token}

Starting an application using API Keys (Deprecated)

Start an application by posting to the /applications endpoint. The body needs to contain the workflowId, market and redirectUrl properties. After the applicant finishes the application they will be redirected to the redirectUrl with the applicationId as a query parameter.

Request

Start application
POST /applications HTTP/1.1
Content-Type: application/json
 
{
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "market": "SE",
  "redirectUrl": "https://acme.com/onboarding-complete"
}

Response

{
  "applicationId": "bits:application:customer:95d0c391-c659-4748-8415-de4f804803a0",
  "sessionToken": "eyJhbGciOiJIUz..."
}

POST /applications

This endpoint is used to create a application for a user. The user will be redirected to the onboarding flow for the given market and workflow.

PropertyTypeDescription
workflowIdstringThe ID of the Workflow you want to initiate.
marketstringThe market you want to initiate the onboarding for.
redirectUrlstringThe URL you want to redirect the user to after the onboarding is completed.

Request

curl
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "workflowId": "<WORKFLOW_ID>",
    "market": "<MARKET>",
    "redirectUrl": "<REDIRECT_URL>",
  }' \
  https://api.bits.bi/applications

Response

{
  "sessionToken": "eyJhbGciOiJIUz...",
  "id": "bits:application:customer:4d72cbf4-070c-4b64-b8a6-86baaee34100"
}
PropertyTypeDescription
sessionTokenstringThe session token you need to use to initiate the onboarding flow.
idstringThe ID of the application.

GET /applications/:id

This endpoint is used to retrieve the application details.

Request

curl
curl "Authorization: Bearer <API_KEY>" \
  https://api.bits.bi/applications/<id>

Response

PropertyTypeDescription
idstringThe ID of the application.
statusstringThe status of the application
{
  "id": "bits:application:customer:4d72cbf4-070c-4b64-b8a6-86baaee34100",
  "status": "Approved"
}