Endpoints
All endpoints require a valid access token with a specific scope for access. Please read Authentication and Authorization documentation.
Versioning
The current version (v1) of the Bits API leverages URL path versioning. Future versions of the API will however switch
to media type versioning.
Read more about it in the chapter on API Versioning. This switch will be announced well in advance and
the docs updated accordingly.
Managing Applications
Create application
POST /v1/applications.create
The endpoint creates an application on the specific workflow and market. All input parameters can be found on the " Integration" tab in a workflow on the Bits Dashboard.
The POST /v1/applications.create will return a sessionToken which is a Bearer token and is only authorized to
perform actions on the application it just created. The sessionToken is used to start the no-code onboarding. The
sessionToken is valid for 60 minutes.
Request
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"workflowId": "<WORKFLOW_ID>",
"countryCode": "<COUNTRY_CODE>",
"redirectUrl": "<REDIRECT_URL>",
}' \
https://api.bits.bi/v1/applications.create
| Property | Type | Description |
|---|---|---|
workflowId | string | Identifies which workflow to commence for the application. |
countryCode | string | Identifies the market country code to commence the application. |
redirectUrl | string | Identifies the URL the applicant should be redirected to once the application is complete. |
Response
{
"id": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100",
"sessionToken": "eyJhbGciOiJIUz..."
}| Property | Type | Description |
|---|---|---|
id | string | Identifier for the created application. |
sessionToken | string | Access token used to execute the application. |
Fetch application status
POST /v1/applications.get
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the status from. |
Response
Returns an ApplicationObject.
Organization
Fetch organization general information
POST /v1/applications.organization.get
The endpoint returns the organization information on an application.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
organizationName | string | The name of the organization. |
organizationNumber | OrganizationIdentifier | The organization number. |
legalType | LegalType | The legal type of the organization. |
foundationDate | Date | The date the organization was founded. |
registrationDate | Date | The date the organization was registered. |
addresses | Array<Address> | The organization's addresses. |
visitAddress | Address | The organization's visiting address. Deprecated, use addresses instead |
postalAddress | Address | The organization's postal address. Deprecated, use addresses instead |
companyStatus | OrganizationStatus | The status of the organization. |
numberOfEmployeesInterval | string | The number of employees in the organization. |
industryCode | IndustryCodes | The industry code of the organization. Deprecated, use industryCodes instead |
industryCodes | Array<IndustryCodes> | The industry codes of the organization. |
businessActivity | string | The business activity of the organization. |
registrationAuthority | RegistrationAuthority | The registration authority of the organization. |
registeredCorporateTaxDate | Date | The date the organization was registered for corporate tax. |
registeredCorporateVatDate | Date | The date the organization was registered for VAT. |
sanctionHits | Array<SanctionHit> | The sanction hits of the organization. |
Fetch org contact details
POST /v1/applications.organization.contactDetails.get
The endpoint returns the organization contact details on an application.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
firstName | string | The first name of the organization contact person. |
lastName | string | The last name of the organization contact person. |
email | string | The email of the organization contact person. |
phoneNumber | string | The phone number of the organization contact person. |
Fetch signing combinations
POST /v1/applications.organization.signingCombinations.get
The endpoint will return the signing combinations for an organization on an application.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
data | Array<Array<SignatoryAuthority>> | The signing combinations for the organization. |
Fetch signed by
POST /v1/applications.organization.signedBy.get
The endpoint will return the person who signed the application. Normally this might be the person who performed the onboarding on behalf of the organization.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
data | Array<SignedBy> | The person who signed the application. |
Fetch board members
POST /v1/applications.organization.boardMembers.get
The endpoint will return the board members for an organization on an application.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
data | Array<Array<GoverningMember>> | The board members for the organization. |
| Property | Type | Description |
|---|---|---|
data | Array<Array<GoverningMember>> | The board members for the organization. |
Person
POST /v1/applications.person.get
Fetch person data
The endpoint will return information on the person related to an application. For KYC that would correspond to the
applicant or onboarded customer.
While for KYB it could be the person who performed the auth or IDV step while onboarding the organization.
The following fields are possibly null, if not collected: dateOfBirth, personalIdentityNumber, coordinationNumber,
address.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
firstName | string | The first name of the person. |
lastName | string | The last name of the person. |
email | string | The email of the person. |
phoneNumber | string | The phone number of the person. |
personalIdentityNumber | PersonalIdentityNumber | The personal identity number of the person. |
dateOfBirth | Date | The date of birth of the person. |
coordinationNumber | PersonalIdentityNumber | The coordination number of the person. |
address | Address | The address of the person. |
pepHits | Array<PepHit> | The PEP hits of the person. |
sanctionHits | Array<PersonSanctionHit> | The sanction hits of the person. |
Fetch person contact details
Deprecated. Email and phone number are available on the get person api
POST /v1/applications.person.contactDetails.get
The endpoint returns the person contact details on an application.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
{
"email": "lois.lane@metropolis.com",
"phoneNumber": "+46701234567"
}List documents uploaded on an application
POST /applications.documents.list
The endpoint lists all documents connected with an application. The value ofdownloadURL in the response body can be
used to download the document with a GET request.
The field uploadedBy can have the following values:
APPLICANT- The document was uploaded by the applicant of an application.CUSTOMER_USER- The document was uploaded by a user via Bits Dashboard.
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
data | Array<Document> | An array of documents. |
List bank accounts on an application
POST /applications.bankAccounts.list
The endpoint lists all bank accounts connected with an application.
The field type can have the following values:
SWEDEN_DOMESTIC- Represents a Swedish bank account. It contains a clearing number (4-5 characters) and an account number (kontonummer, 5-11 characters).IBAN- Represents an international bank account number. It contains a string (up to 34 characters).
Request
{
"applicationId": "bits:application::4d72cbf4-070c-4b64-b8a6-86baaee34100"
}| Property | Type | Description |
|---|---|---|
applicationId | string | Identifies which application to fetch the information from. |
Response
| Property | Type | Description |
|---|---|---|
data | Array<BankAccount> | An array of bank accounts. |