API
Deprecated Webhook Events
⚠️

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

Webhook Events (Deprecated)

We will send you a webhook when the application status changes. The webhook will be sent to the webhook specificd in the Bits Technology Dashboard.

All webhooks will be sent as JSON and will be contain the payload in the body, all requests sent to you will be as a POST request.

In rare occasions you may recieve duplicate events. You should treat events as idempotent to avoid unwated effects in your application. We garantee at-least-once delivery of events.

ApplicationEvents

ApplicationStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationStartedEvent"
}

ApplicationApprovedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationApprovedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationApprovedEvent"
}

ApplicationDeclinedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationDeclinedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationDeclinedEvent"
}

ApplicationCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationCancelledEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationCancelledEvent"
}

ApplicationFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationFailedEvent"
}

ApplicationManualReviewEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationManualReviewEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationManualReviewEvent"
}

ApplicationManualReviewApprovedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationManualReviewApprovedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationManualReviewApprovedEvent"
}

ApplicationManualReviewDeclinedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
workflowIdBits Resource Namemarket identifier
customerIdBits Resource NameUnique identifier for the Bits customer
eventTypeApplicationDeclinedThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "workflowId": "bits:project:workflow:95d0c391-c659-4748-8415-de4f804803a0",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ApplicationManualReviewDeclinedEvent"
}

TasksStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
tasksarray of EventTaskList of tasks
eventTypeTasksStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:ebb2d8ff-6d66-4e02-b1e6-e1997b95e7a8",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "tasks": {
    "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
    "stepId": "bits:step:idv:4236f534-d60d-4564-83c1-2813b0fef3ee",
    "stepType": "IDV",
    "providers": [
      {
        "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f"
      },
      {
        "providerId": "bits:provider:roaring:b7e9f70b-0146-485d-b259-30040caf113f"
      }
    ]
  },
  "eventType": "TasksStartedEvent"
}

TaskApprovedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
eventTypeTaskApprovedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskApprovedEvent"
}

TaskDeclinedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
eventTypeTaskDeclinedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskDeclinedEvent"
}

TaskFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
eventTypeTaskFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskFailedEvent"
}

TaskCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
eventTypeTaskCancelledEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskCancelledEvent"
}

TaskManualReviewEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
reasonsarray of stringsList of reasons for the manual review
eventTypeTaskManualReviewThe type of event
{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "reasons": ["REASON_ROARING_CIVIL_REGISTRY_COMPLETED_EVENT_IS_NIL"],
  "eventType": "TaskManualReviewEvent"
}

TaskManualApprovedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
customerUserIdBits Resource NameUnique identifier for the user approving the application
eventTypeTaskManualReviewThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "customerUserId": "bits:customer:user:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskManualApprovedEvent"
}

TaskManualDeclinedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
stepIdBits Resource NameUnique identifier for the step
customerUserIdBits Resource NameUnique identifier for the user declining the application
eventTypeTaskManualReviewThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "stepId": "bits:step:idv:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "customerUserId": "bits:customer:user:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "TaskManualDeclinedEvent"
}

ProviderStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeProviderStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:pep:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ProviderStartedEvent"
}

ProviderCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeProviderCompletedThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:pep:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ProviderCompletedEvent"
}

ProviderFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeProviderFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:pep:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ProviderFailedEvent"
}

ProviderCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeProviderCancelledThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:pep:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "eventType": "ProviderCancelledEvent"
}

BankIDEvents

BankIDAuthInitiatedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDAuthInitiatedThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDAuthInitiatedEvent"
}

BankIDAuthCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDAuthCancelledThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDAuthCancelledEvent"
}

BankIDAuthCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
orderRefstringBankID:s identifier for the authentication session
userobjectUser object
deviceobjectDevice object
signaturestringBankID signature
bankIDIssueDatestringDate when the applicant BankID was issued
stepUpboolFlag signifying increased BankID security
ocspResponsestringBankID OCSP Response
eventTypeBankIDAuthCompletedThe type of event

Example Response

{
  "applicationId": "bits:application:customer:57740be5-96b4-4465-a0c7-bca76aafd589",
  "bankIdIssueDate": "2021-11-28Z",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "device": {
    "ipAddress": "158.174.40.90",
    "uhi": "1+cJMICE2u76b9Y9zed7j4rxGio="
  },
  "ocspResponse": "MIIHXAoBAKCCB1UwggdRBgkrBgEFBQcwAQEEggdCMIIHPjCCAR+hfDB6MQswCQYDVQQGEwJTRTEbMBkGA1UECgwSU3dlZGJhbmsgQUIgKHB1Ymwp...",
  "orderRef": "1965501b-25ea-4ffa-9a64-b83cf20c2efa",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "signature": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PFNpZ25hdHVyZSB4bWxucz0iaHR0cDovL3d3dy53My5vc...",
  "stepUp": false,
  "taskId": "bits:task:application:5e42c44c-1c82-447b-9f39-7d9732496779",
  "user": {
    "givenName": "JOHN",
    "name": "JOHN SMITH",
    "personalNumber": "198001010000",
    "surName": "SMITH"
  },
  "event": "BankIDAuthInitiatedEvent"
}

BankIDAuthFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDAuthFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDAuthFailedEvent"
}

BankIDSignInitiatedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDSignInitiatedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDSignInitiatedEvent"
}

BankIDSignCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDSignCancelledThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDSignCancelled"
}

BankIDSignCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
orderRefstringBankID:s identifier for the authentication session
userobjectUser object
deviceobjectDevice object
signaturestringBankID signature
bankIDIssueDatestringDate when the applicant BankID was issued
stepUpboolFlag signifying increased BankID security
ocspResponsestringBankID OCSP Response
eventTypeBankIDSignCompletedThe type of event

Example Response

{
  "applicationId": "bits:application:customer:57740be5-96b4-4465-a0c7-bca76aafd589",
  "bankIdIssueDate": "2021-11-28Z",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "device": {
    "ipAddress": "158.174.40.90",
    "uhi": "1+cJMICE2u76b9Y9zed7j4rxGio="
  },
  "ocspResponse": "MIIHXAoBAKCCB1UwggdRBgkrBgEFBQcwAQEEggdCMIIHPjCCAR+hfDB6MQswCQYDVQQGEwJTRTEbMBkGA1UECgwSU3dlZGJhbmsgQUIgKHB1Ymwp...",
  "orderRef": "1965501b-25ea-4ffa-9a64-b83cf20c2efa",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "signature": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PFNpZ25hdHVyZSB4bWxucz0iaHR0cDovL3d3dy53My5vc...",
  "stepUp": false,
  "taskId": "bits:task:application:5e42c44c-1c82-447b-9f39-7d9732496779",
  "user": {
    "givenName": "JOHN",
    "name": "JOHN SMITH",
    "personalNumber": "198001010000",
    "surName": "SMITH"
  },
  "eventType": "BankIDSignCompletedEvent"
}

BankIDSignFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
orderRefstringBankID:s identifier for the authentication session
eventTypeBankIDSignFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:6640c1c7-f07e-46af-9033-f624b0653573",
  "taskId": "bits:task:application:401c5c16-6586-4c04-9771-815575e8c71b",
  "customerId": "bits:customer:organization:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "providerId": "bits:provider:bankid:93447ede-1d78-48e9-bca8-52e9dbcef5e5",
  "orderRef": "db84fadd-198f-4932-b13f-e3ce16b4757d",
  "eventType": "BankIDSignFailedEvent"
}

QuestionnaireEvents

QuestionnaireInitiatedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeQuestionnaireInitiatedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "orderRef": "5eb8cd42-b418-484e-813a-dd0cbba9153c",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "eventType": "QuestionnaireInitiatedEvent"
}

QuestionnaireCancelledEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
answersobjectPartial answers object
eventTypeQuestionnaireCancelledEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:1d53931c-18da-40b5-aea1-bb3e95e912ce",
  "eventType": "QuestionnaireCancelledEvent",
  "answers": {
    "1.1": {
      "text": "test@test.com"
    },
    "1.2": {
      "text": "1234"
    },
    "2.2": {
      "alternativeIds": ["2.2-1"]
    },
    "2.3": {
      "alternativeIds": ["country-au"]
    },
    "2.4": {
      "text": "Test"
    },
    "8.1": {
      "alternativeIds": ["8.1-1"]
    }
  },
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "providerId": "bits:provider:questionnaire:df880c7b-d3d2-4854-bb1b-faa5cc534c5a",
  "taskId": "bits:task:application:3a531915-7de1-4d19-b92e-67dd2e263f85"
}

QuestionnaireCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
answersobjectComplete answers object
eventTypeQuestionnaireCompletedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:1d53931c-18da-40b5-aea1-bb3e95e912ce",
  "eventType": "QuestionnaireCompletedEvent",
  "answers": {
    "1.1": {
      "text": "test@test.com"
    },
    "1.2": {
      "text": "1234"
    },
    "2.2": {
      "alternativeIds": ["2.2-1"]
    },
    "2.3": {
      "alternativeIds": ["country-au"]
    },
    "2.4": {
      "text": "Test"
    },
    "8.1": {
      "alternativeIds": ["8.1-1"]
    }
  },
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "providerId": "bits:provider:questionnaire:df880c7b-d3d2-4854-bb1b-faa5cc534c5a",
  "taskId": "bits:task:application:3a531915-7de1-4d19-b92e-67dd2e263f85"
}

RoaringCivilRegistryEvents

RoaringCivilRegistryStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringCivilRegistryStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringCivilRegistryStartedEvent"
}

RoaringCivilRegistryCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
fullPersonRoaringFullPersonRoaringFullPerson
eventTypeRoaringCivilRegistryCompletedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "fullPerson": {
    "addresses": [
      {
        "city": "STOCKHOLM",
        "country": "SE",
        "dateFrom": "2019-12-02T00:00:00Z",
        "dateTo": "9999-12-31T00:00:00Z",
        "isCurrent": true,
        "postalCode": "12345",
        "streetAddress": "Smith Street 7"
      }
    ],
    "dateOfBirth": "1980-01-01",
    "firstName": "John",
    "gender": "Male",
    "lastName": "Smith",
    "personalNumber": "198001010000",
    "providerId": "bits:provider:roaring:b7e9f70b-0146-485d-b259-30040caf113f",
    "secret": {
      "DateFrom": "0001-01-01T00:00:00Z",
      "Secret": false
    }
  },
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringCivilRegistryCompletedEvent"
}

RoaringCivilRegistryFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringCivilRegistryFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringCivilRegistryFailedEvent"
}

RoaringPepEvents

RoaringNordicPepStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringPepStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringNordicPepStartedEvent"
}

RoaringNordicPepCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
hitsarray of RoaringNordicPepHitsList of RoaringNordicPepHits
eventTypeRoaringPepCompletedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "hits": [],
  "eventType": "RoaringNordicPepCompletedEvent"
}

RoaringNordicPepFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringPepFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringNordicPepFailedEvent"
}

RoaringSantionsEvents

RoaringSanctionsStartedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringSanctionsStartedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringSanctionsStartedEvent"
}

RoaringSanctionsCompletedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
hitsarray of RoaringSanctionHitsList of RoaringSanctionHits
eventTypeRoaringSanctionsCompletedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "hits": [],
  "eventType": "RoaringSanctionsCompletedEvent"
}

RoaringSanctionsFailedEvent

KeyTypeDescription
applicationIdBits Resource NameUnique identifier for the application
taskIdBits Resource NameUnique identifier for the task
customerIdBits Resource NameUnique identifier for the Bits customer
providerIdBits Resource NameUnique identifier for the provider
eventTypeRoaringSanctionsFailedEventThe type of event

Example Response

{
  "applicationId": "bits:application:customer:394b460c-bae7-400d-bdab-2d6dde7bebcb",
  "taskId": "bits:task:application:046afe82-b8ef-432e-85fe-2b3d1b469301",
  "providerId": "bits:provider:bankid:bb9d8238-1706-4afb-8980-05a469eea46f",
  "customerId": "bits:customer:organization:9deecf86-6bb8-4e47-9921-424d9870e9aa",
  "eventType": "RoaringSanctionsFailedEvent"
}