API docs by Redocly

Partner Api (0.0.0-dev)

Download OpenAPI specification:

License: MIT

Welcome to the Monitum Partner API! 🚀

The Monitum Partner API is a specialized API designed to allow Monitum's business partners to integrate with their services. It provides endpoints for accessing various resources or services offered by Monitum, and access to the API is regulated using the OAuth 2.0 Client Credentials Flow for secure communication.

Here’s an explanation of the key aspects of the Partner API:

What is the Partner API?

The Partner API allows Monitum's partners to interact programmatically with Monitum's platform. It provides a way for partners to send and receive data, automate workflows, and integrate Monitum's services with their own systems.

The Monitum Partner API provides a focused set of functionalities to enable partners to efficiently manage subscriptions and leverage end-user data for enhanced user experiences. Here’s a breakdown of its core purposes and capabilities:

Key Purposes of the Monitum Partner API

  1. Subscription Management
  • Add Subscriptions: Automate the onboarding process by programmatically subscribing users or clients to Monitum's services.
  • Cancel/Remove Subscriptions: Streamline the cancellation or downgrade process to handle subscription lifecycles effortlessly.
  1. User Data Exposure for Custom Experiences
  • Enable partners to access end-user information securely.
  • This data can be used to:
    • Build personalized user interfaces.
    • Tailor experiences based on user preferences and history.
    • Develop custom workflows or integrations that improve user engagement.

Limitations

The Monitum Partner API serves as a supplementary tool to the Monitum CRM, offering limited but essential features for customer management.

  • Do not handle management of campaigns or price plan
  • Do not handle management of sales representative or reseller
  • Do not handle management of users of the CRM
  • Do not handle management of the CRM itself
  • Do not handle management of the Billing or Payment system

Steps to Access the Monitum API

  1. Establish a Contract with Monitum
  • Before using the API, you need to establish a contract with Monitum.
  • This process involves registering as a partner and acquiring credentials specific to your organization.
  1. Obtain Credentials

After the contract is set up, Monitum will provide the following:

  • Client ID: Unique identifier for your application.
  • Client Secret: Confidential key used to authenticate your application.
  • Partner ID: Identifier linking your requests to your partnership.
  1. Authentication Method: Client Credentials Flow
  • Monitum's API uses the Client Credentials Flow, a part of the OAuth 2.0 framework, for authentication.
  1. Specify the Partner API Audience
  • When sending a request to get an access token, set the audience to:
https://partner-api.monitum.io

  • This tells the authentication server which API you’re requesting access to.

    1. Make a Token Request

  • Use your Client ID and Client Secret to obtain an access token.

  • This token will authorize your requests to the Monitum API.

Example (using cURL):

curl -X POST https://auth.monitum.io/oauth/token \
-H "Content-Type: application/json" \
  -d '{
"grant_type": "client_credentials",
"client_id": "<your-client-id>",
"client_secret": "<your-client-secret>",
"audience": "https://partner-api.monitum.io"
}'

  1. Receive the Access Token

    • The authentication server will respond with an access token. Example response:

      {
  "access_token": "your-access-token",
  "token_type": "Bearer",
  "expires_in": 3600
}

    • Save the access token securely and use it in subsequent API requests.

  2. Access Monitum API

    • Include the access token in the Authorization header for your API calls:

      Example (using cURL):

      curl -X GET https://partner-api.monitum.io/resource \
  -H "Authorization: Bearer <your-access-token>"

Notes

  • Token Expiry: Tokens are valid for a limited time (e.g., 3600 seconds). You'll need to refresh it by repeating the token request process.

  • Secure Your Credentials: Never expose your Client Secret in client-side code, or in any public or private repositories.

    If you have any questions or need further clarification, let us know!

Customer

Get Customers

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

customerId
string

Filter customers by their assigned customer ID

identityNumber
string

Filter customers by their personal identity number (Personnummer)

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create Customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
nationality
required
string

ISO 3166-1 alpha-2 country code representing the nationality of the customer

Email (string) or null

The email address associated with the customer account or null to remove email

firstName
required
string

The first name of the customer

lastName
required
string

The last name of the customer

address
required
string

The street address of the customer

coAddress
string

Care of address, additional address information

postalCode
required
string

The postal code for the customer's address

city
required
string

The city of the customer's address

phone
required
string

The phone number associated with the customer account

mobile
string
password
string
customerType
required
string

Indicates whether the customer is a private individual ('private') or a business ('business').

Value: "private"
required
string or string (IdentityNumber)

Responses

Request samples

Content type
application/json
Example
{
  • "nationality": "string",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "coAddress": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "mobile": "string",
  • "password": "string",
  • "customerType": "private",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update Customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

Request Body schema: application/json
nationality
required
string

ISO 3166-1 alpha-2 country code representing the nationality of the customer

Email (string) or null

The email address associated with the customer account or null to remove email

firstName
required
string

The first name of the customer

lastName
required
string

The last name of the customer

address
required
string

The street address of the customer

coAddress
string

Care of address, additional address information

postalCode
required
string

The postal code for the customer's address

city
required
string

The city of the customer's address

phone
required
string

The phone number associated with the customer account

mobile
string
password
string
customerType
required
string

Indicates whether the customer is a private individual ('private') or a business ('business').

Value: "private"
required
string or string (IdentityNumber)

Responses

Request samples

Content type
application/json
Example
{
  • "nationality": "string",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "coAddress": "string",
  • "postalCode": "string",
  • "city": "string",
  • "phone": "string",
  • "mobile": "string",
  • "password": "string",
  • "customerType": "private",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete Customer

Permanently removes a customer record. All associated services must be deleted before customer removal.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Initiate password reset for a customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required

Request body to initiate password reset

username
required
string

The IdentityNumber of the customer requesting a password reset

messageTemplate
string
Default: "Hej {{firstName}} {{lastName}}, detta är en kod för att återställa ditt lösenord från {{partnerName}}: {{resetCode}}"

Optional custom message template for the password reset email. If not provided, the default template will be used. The template should include a placeholder {{resetCode}} where the reset token will be inserted. Also available placeholders are {{firstName}},{{lastName}} and {{partnerName}}

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "messageTemplate": "Hej {{firstName}} {{lastName}}, detta är en kod för att återställa ditt lösenord från {{partnerName}}: {{resetCode}}"
}

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Complete password reset for a customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required

Request body to complete password reset

username
required
string

The IdentityNumber of the customer requesting a password reset

resetCode
required
string

The password reset token provided to the customer

newPassword
required
string^(?=.*?[A-Z])(?=.*?[a-z])(?=.*?[0-9])(?=.*?[^...

(?=.?[A-Z]) : At least one upper case English letter (?=.?[a-z]) : At least one lower case English letter (?=.?[0-9]) : At least one digit (?=.?[^A-Za-z\d]) : At least one special character (including space) .{8,} : Minimum eight in length

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "resetCode": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Customer services

Get A list of a customers services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create Service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

Request Body schema: application/json
serviceType
required
any
Value: "FraudProtection"
string or string (IdentityNumber)
status
required
string (FraudProtectionStatus)
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Current status of the Fraud Protection subscription

activeTo
string <date-time>
campaign
string
resellerId
required
string
pricePlanId
required
string

Subscription price plan, automatically set to begin at the start of the current day

salesRepresentative
string

Identifier of the sales representative associated with the account

customerId
required
string

Matches the customerId field specified in the Customer object

leadSource
string

Point of origin or source from which the sales lead was generated.

packageType
required
string

Product package type classification

Responses

Request samples

Content type
application/json
Example
{
  • "serviceType": "FraudProtection",
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "campaign": "string",
  • "resellerId": "string",
  • "pricePlanId": "string",
  • "salesRepresentative": "string",
  • "customerId": "string",
  • "leadSource": "string",
  • "packageType": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

serviceId
required
string

Unique identifier for a service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update Service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

serviceId
required
string

Unique identifier for a service subscription

Request Body schema: application/json
serviceType
required
any
Value: "FraudProtection"
string or string (IdentityNumber)
status
required
string (FraudProtectionStatus)
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Current status of the Fraud Protection subscription

activeTo
string <date-time>
campaign
string
resellerId
required
string
pricePlanId
required
string

Subscription price plan, automatically set to begin at the start of the current day

salesRepresentative
string

Identifier of the sales representative associated with the account

customerId
required
string

Matches the customerId field specified in the Customer object

leadSource
string

Point of origin or source from which the sales lead was generated.

packageType
required
string

Product package type classification

Responses

Request samples

Content type
application/json
Example
{
  • "serviceType": "FraudProtection",
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "campaign": "string",
  • "resellerId": "string",
  • "pricePlanId": "string",
  • "salesRepresentative": "string",
  • "customerId": "string",
  • "leadSource": "string",
  • "packageType": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete Customer

Removes a service subscription from the customer account. Service must be removed before customer deletion

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

serviceId
required
string

Unique identifier for a service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection

Get fraud protection

Retrieves all Fraud Protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create fraud protection

Creates a new Fraud Protection service subscription In order to create a new Fraud Protection service, a customer must exist connected to the identityNumber.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
string or string (IdentityNumber)
status
string
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Optional on create; when omitted, defaults to Active.

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get fraud protection by id

Retrieves details of a specific Fraud Protection service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Updates a fraud protection subscription

Updates an existing Fraud Protection service configuration

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Request Body schema: application/json
required
string or string (IdentityNumber)
status
string (FraudProtectionStatus)
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Current status of the Fraud Protection subscription

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Deletes a fraud protection subscription

Removes a Fraud Protection service and associated data

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection Monitored Persons

Get monitored persons

Retrieves list of persons monitored under this protection service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Creates monitored persons

Adds a person to be monitored by the Fraud Protection service (maximum 5 persons per subscription)

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Request Body schema: application/json
Any of
phone
required
string <phone> non-empty

Phone number of the monitored person and contact channel (for alarms and notifications).

string or null
required
string or string (IdentityNumber)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": null,
  • "email": null,
  • "identityNumber": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get monitored persons

Retrieves details of a specific monitored person (subscription limit: 5 persons)

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update a monitored person

Updates information for a monitored person

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Request Body schema: application/json
Any of
phone
required
string <phone> non-empty

Phone number of the monitored person and contact channel (for alarms and notifications).

string or null
required
string or string (IdentityNumber)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "phone": null,
  • "email": null,
  • "identityNumber": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete a monitored person

Removes a person from Fraud Protection monitoring

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud protection Personal Overview

Get personal information

Retrieves personal information (requires Dun & Bradstreet contract and consent verification)

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Fraud Protections mobile

Get mobiles by fraud protection id

Retrieves list of protected mobile devices

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create mobiles by fraud protection id

Registers a new mobile device for theft protection

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get mobile by fraud protection id

Retrieves details of a specific protected mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update mobile by fraud protection id

Updates information for a protected mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete mobile by fraud protection id

Removes a mobile device from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protections credit cards

Get credit cards by company monitoring id

Retrieves list of protected credit cards

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get credit cards by personal monitoring id

Registers a new credit card for Fraud Protection

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by company monitoring id

Retrieves details of a specific protected credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by personal monitoring id

Updates information for a protected credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by personal monitoring id

Removes a credit card from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionId
required
string
Example: 2

Unique identifier for a Fraud Protection service subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection Base

Get fraud protection bases

Retrieves all Fraud Protection Base service subscriptions. Each list item always includes identityNumber.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create fraud protection base

Creates a new Fraud Protection Base service subscription. The request body must include identityNumber. Responses echo the subscription including identityNumber when available.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
string or string (IdentityNumber)
status
string
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Optional on create; when omitted, defaults to Active.

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get fraud protection base by id

Retrieves details of a specific Fraud Protection Base service subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionBaseId
required
string
Example: 2

Unique identifier for a Fraud Protection Base service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update a fraud protection base subscription

Updates an existing Fraud Protection Base service configuration.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionBaseId
required
string
Example: 2

Unique identifier for a Fraud Protection Base service subscription

Request Body schema: application/json
required
string or string (IdentityNumber)
status
string
Enum: "Active" "Regret" "Shredded" "Churned" "Goodwill" "UpSale" "Upgraded" "Downgraded"

Optional on create; when omitted, defaults to Active.

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete a fraud protection base subscription

Removes a Fraud Protection Base service and associated data.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

fraudProtectionBaseId
required
string
Example: 2

Unique identifier for a Fraud Protection Base service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection 360

List Fraud Protection 360 subscriptions

Retrieves all Fraud Protection 360 subscriptions for the partner.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

properties
Array of strings
Example: properties=status&properties=activeTo

Optional list of field names to include in each returned resource. Fields required by the resource schema are always returned regardless of this filter.

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create Fraud Protection 360 subscription

Creates a new Fraud Protection 360 subscription. A customer must exist for the given identityNumber. Multiple active 360 subscriptions per customer are allowed.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
required
string or string (IdentityNumber)
packageType
required
string (FraudProtection360PackageType)
Enum: "Uno" "Duo" "Family" "Base" "BoardMember" "Staff"

Product package type for Fraud Protection 360 (aligned with fraud-protection product definitions).

Active invitation limits per subscription: Uno 0, Duo 1, Family 4, Base / BoardMember / Staff unlimited.

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "packageType": "Uno",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Fraud Protection 360 subscription

Retrieves a specific Fraud Protection 360 subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
properties
Array of strings
Example: properties=status&properties=activeTo

Optional list of field names to include in each returned resource. Fields required by the resource schema are always returned regardless of this filter.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update Fraud Protection 360 subscription

Updates an existing Fraud Protection 360 subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Request Body schema: application/json
required
packageType
string (FraudProtection360PackageType)
Enum: "Uno" "Duo" "Family" "Base" "BoardMember" "Staff"

Product package type for Fraud Protection 360 (aligned with fraud-protection product definitions).

Active invitation limits per subscription: Uno 0, Duo 1, Family 4, Base / BoardMember / Staff unlimited.

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "packageType": "Uno",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete Fraud Protection 360 subscription

Soft-deletes the subscription: status is set to Cancelled, monitoring stops, and monitored persons and consent records are retained for audit. The subscription is excluded from active listings.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Fraud Protection 360 Monitored Persons

List monitored persons

Retrieves monitored persons for a Fraud Protection 360 subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Add monitored person

Adds a monitored person directly to the subscription. To invite additional persons subject to package limits, use the invitations resource instead. The person is created with consentStatus: Pending. Monitoring does not start until consent is verified.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Request Body schema: application/json
required
Any of
phone
required
string or null <phone> non-empty

Phone number of the monitored person and contact channel (for alarms and notifications).

(string or null) or (string or null)
name
required
string <= 1024 characters

Name of the monitored person.

required
IdentityNumberSE (string) or IdentityNumberNO (string)
required
object (MonitoredPersonAddress)
emailNotification
required
boolean
Default: true

false no emails will be sent for this subscription to this person

smsNotification
required
boolean
Default: true

false no sms will be sent for this subscription to this person

language
required
string <ISO 639> (LanguageCode) ^[a-z]{2}$

Language code following the ISO 639 standard, e.g. 'sv' for swedish nn nynorsk

role
string or null
Enum: "admin" null

Optional permission on this monitored person. admin may manage other monitored people on the same subscription. Several admins are allowed. Set to null to revoke. Omitted means no change.

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "user@example.com",
  • "name": "string",
  • "identityNumber": "string",
  • "address": {
    },
  • "emailNotification": true,
  • "smsNotification": true,
  • "language": "string",
  • "role": "admin"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get monitored person

Retrieves a monitored person by Swedish national identity number.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update monitored person

Updates contact details for a monitored person identified by identityNumber.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Request Body schema: application/json
required
name
string

The name of the monitored person e.g. David Valander

emailNotification
boolean
Default: true

false no emails will be sent for this subscription to this person

smsNotification
boolean
Default: true

false no sms will be sent for this subscription to this person

language
string <ISO 639> (LanguageCode) ^[a-z]{2}$

Language code following the ISO 639 standard, e.g. 'sv' for swedish nn nynorsk

email
string or null <email>

Contact channel for person (invitation, alarms and notifications).

phone
string or null

Contact channel for person (invitation, alarms and notifications).

role
string or null
Enum: "admin" null

Optional permission on this monitored person. admin may manage other monitored people on the same subscription. Several admins are allowed. Set to null to revoke. Omitted means no change.

object (MonitoredPersonAddress)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "emailNotification": true,
  • "smsNotification": true,
  • "language": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "role": "admin",
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Remove monitored person

Removes a monitored person from the subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

identityNumber
required
string
Example: 19700101-1234

Swedish National identification number used to verify identity

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection 360 Invitations

List invitations

Lists pending and accepted invitations for the subscription. Revoked invitations are excluded from active listings.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create invitation

Invites a person to join the subscription as a monitored person. The invite is delivered to the invitee via SMS, email, or both.

Package invitation limits (active pending invitations per subscription):

  • Uno — 0 (invitations not allowed)
  • Duo — 1
  • Family — 4
  • Base, BoardMember, Staff — unlimited

Returns 403 when the subscription package limit is reached. When the invitee accepts, a monitored person is created with consentStatus: Pending until BankID consent is verified.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Request Body schema: application/json
required
Any of
phone
required
string <phone> non-empty

Phone number of the monitored person and contact channel (for alarms and notifications).

Email (string) or null

Mail of the monitored person and contact channel (for alarms and notifications).

required
string or string (IdentityNumber)
name
required
string

Name to who the invitation address.

Responses

Request samples

Content type
application/json
{
  • "phone": "string",
  • "email": "user@example.com",
  • "identityNumber": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update invitation status

Changes the status of a pending invitation. Set Accepted once the invitee has consented (the monitored person becomes active) or Declined if the invitee refused consent.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

invitationId
required
string (Id)

Unique identifier for an invitation

Request Body schema: application/json
required
status
required
string
Enum: "Accepted" "Declined"

Target status for the invitation:

  • Accepted — the invitee consented; the monitored person becomes active
  • Declined — the invitee refused consent

Responses

Request samples

Content type
application/json
{
  • "status": "Accepted"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Revoke invitation

Revokes a pending invitation. The invitee can no longer accept it. Only invitations with status: Pending can be revoked.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

invitationId
required
string (Id)

Unique identifier for an invitation

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection 360 Personal Information

Get personal information profile

Retrieves personal information for a specific subject on the subscription. The request MUST include identityNumber identifying the person. Access requires personal_info scope and verified consent for that subject — consent on other monitored persons does not grant access.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
required
IdentityNumberSE (string) or IdentityNumberNO (string) (IdentityNumber)

Subject identity number — per-subject verified consent is required for personal information access

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get personal information events

Retrieves personal information monitoring events for a specific subject. The request MUST include identityNumber identifying the person. Requires personal_info scope and verified consent for that subject. Returns 403 when consent is missing or not verified.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
required
IdentityNumberSE (string) or IdentityNumberNO (string) (IdentityNumber)

Subject identity number — per-subject verified consent is required for personal information access

page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Fraud Protection 360 mobile

Get mobiles by fraud protection 360 subscription id

Retrieves list of protected mobile devices

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create mobile by fraud protection 360 subscription id

Registers a new mobile device for theft protection

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get mobile by fraud protection 360 subscription id

Retrieves details of a specific protected mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update mobile by fraud protection 360 subscription id

Updates information for a protected mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete mobile by fraud protection 360 subscription id

Removes a mobile device from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Fraud Protection 360 credit cards

Get credit cards by fraud protection 360 subscription id

Retrieves list of protected credit cards

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create credit card by fraud protection 360 subscription id

Registers a new credit card for Fraud Protection 360

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit card by fraud protection 360 subscription id

Retrieves details of a specific protected credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update credit card by fraud protection 360 subscription id

Updates information for a protected credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete credit card by fraud protection 360 subscription id

Removes a credit card from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

subscriptionId
required
string (Id)
Example: fp360-001

Unique identifier for a Fraud Protection 360 subscription

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Smart Smoke

Get smart smoke

Retrieves all Smart Smoke services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create smart smoke

Creates a new Smart Smoke service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
string or string (IdentityNumber)
activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0
}

Get smart smoke by id

Retrieves details of a specific Smart Smoke service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update smart smoke

Updates an existing Smart Smoke service configuration

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Request Body schema: application/json
required
string or string (IdentityNumber)
status
string (SmartSmokeStatus)
Enum: "Active" "Regret" "Shredded" "Churn" "Goodwill" "Registered" "CampaignTemplate" "Configure" "Broken"

Current operational status of the Smart Smoke subscription

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0
}

Delete smart smoke

Removes a Smart Smoke service from the system

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Smart Smoke subscribers

Get smart smoke subscribers

Retrieves all notification subscribers for this Smart Smoke

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": [
    ]
}

Create smart smoke subscriber

Adds a new notification subscriber to the Smart Smoke service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Request Body schema: application/json
name
required
string
relation
string
alarmNotification
boolean
smartSmokeId
string <iri-reference>
isPrimaryContact
boolean
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "relation": "string",
  • "alarmNotification": true,
  • "smartSmokeId": "/entity/1",
  • "isPrimaryContact": true,
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get smart smoke subscriber by id

Retrieves details of a specific notification subscriber

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

subscriberId
required
string

Unique identifier for a person receiving Smart Smoke notifications

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update smart smoke subscriber

Updates information for an existing notification subscriber

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

subscriberId
required
string

Unique identifier for a person receiving Smart Smoke notifications

Request Body schema: application/json
name
required
string
relation
string
alarmNotification
boolean
smartSmokeId
string <iri-reference>
isPrimaryContact
boolean
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "relation": "string",
  • "alarmNotification": true,
  • "smartSmokeId": "/entity/1",
  • "isPrimaryContact": true,
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete smart smoke subscriber

Removes a notification subscriber from the service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

subscriberId
required
string

Unique identifier for a person receiving Smart Smoke notifications

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Smart Smoke devices

Get list of connected smart smoke devices for a smart smoke

Retrieves all registered Smart Smoke devices

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": [
    ]
}

Get smart smoke device status and information

Retrieves details of a specific Smart Smoke device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

deviceId
required
string (Id)

Unique identifier for a physical Smart Smoke device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update smart smoke device status and information

Updates configuration for a particular Smart Smoke device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

smartSmokeId
required
string

Unique identifier for a Smart Smoke service subscription

deviceId
required
string (Id)

Unique identifier for a physical Smart Smoke device

Request Body schema: application/json
placement
required
string

Responses

Request samples

Content type
application/json
{
  • "placement": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Smart Smoke RMA

Company Monitoring

Get company monitoring

Retrieves a list of all company monitoring services for the partner

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create company monitoring

Creates a new company monitoring service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
object (CompanyMonitoringSubscriber)

Contact information for notification delivery and service updates

monitoringPlan
required
string
Enum: "basic" "standard"

Subscription plan level: 'basic' (up to 10 companies) or 'standard' (up to 50 companies)

status
required
string (CompanyMonitoringStatus)
Enum: "Active" "Regret" "Shredded" "Churn" "Goodwill" "UpSale"
activeTo
string <date-time>
required
string or string (IdentityNumber)

Responses

Request samples

Content type
application/json
{
  • "subscriber": {
    },
  • "monitoringPlan": "basic",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get company monitoring by id

Retrieves details of a specific company monitoring service by ID

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update company monitoring

Updates an existing company monitoring service configuration

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Request Body schema: application/json
required
object (CompanyMonitoringSubscriber)

Contact information for notification delivery and service updates

monitoringPlan
required
string
Enum: "basic" "standard"

Subscription plan level: 'basic' (up to 10 companies) or 'standard' (up to 50 companies)

status
required
string (CompanyMonitoringStatus)
Enum: "Active" "Regret" "Shredded" "Churn" "Goodwill" "UpSale"
activeTo
string <date-time>
required
string or string (IdentityNumber)

Responses

Request samples

Content type
application/json
{
  • "subscriber": {
    },
  • "monitoringPlan": "basic",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0
}

Delete company monitoring

Removes a company monitoring service and associated data

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Company Monitoring Monitored Company

Get companies by company monitoring id

Retrieves the list of companies being monitored within this service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Adds a monitoring to the subscription.

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Request Body schema: application/json
name
required
string
registrationNumber
required
string

Official company registration number used as unique identifier

brand
required
string

Company's registered brand or trade name

manuallyAdded
required
boolean

Indicates if this company has been manually added. I.e a company were the person does not have any commitment. Companies where the person have commitments are automatically monitored.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "registrationNumber": "string",
  • "brand": "string",
  • "manuallyAdded": true
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete company monitoring

Removes a company from the monitoring service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

registrationNumber
required
string

Official registration number that uniquely identifies a company

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Company Information

Get company key figures

Retrieves detailed information about a specific monitored company

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

registrationNumber
required
string

Official registration number that uniquely identifies a company

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Search for companies by name or registration number

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
integer [ 1 .. 50 ]
Default: 10

Number of results to return per page

question
required
string

Search parameter to find companies by name or registration number

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Company Barrings mobile

Get mobiles by company monitoring id

Retrieves all registered mobile devices that can be locked if reported lost or stolen

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Create mobile for company monitoring

Registers a new mobile device for loss/theft protection

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get mobile by company monitoring id

Retrieves information about a specific registered mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update mobile by company monitoring id

Updates information for a registered mobile device

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Request Body schema: application/json
fullName
required
string
required
string or string (IdentityNumber)
operator
required
string
imei
required
string
msisdn
required
string

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "identityNumber": "string",
  • "operator": "string",
  • "imei": "string",
  • "msisdn": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Delete mobile by company monitoring id

Removes a mobile device from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

mobileId
required
string
Example: 1

Unique identifier for a registered mobile device

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Company Barrings credit cards

Get credit cards by company monitoring id

Retrieves all registered credit cards that can be blocked if reported lost or stolen

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get credit cards by company monitoring id

Registers a new credit card for loss/theft protection

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by company monitoring id

Retrieves information about a specific registered credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by company monitoring id

Updates information for a registered credit card

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Request Body schema: application/json
cardHolder
required
string <= 1024 characters
required
string or string (IdentityNumber)
issuedBy
required
string <= 1024 characters
brand
required
string <= 1024 characters
cardNumber
required
string = 4 characters ^\d{4}$

The last 4 digits of the card number.

Responses

Request samples

Content type
application/json
{
  • "cardHolder": "string",
  • "identityNumber": "string",
  • "issuedBy": "string",
  • "brand": "string",
  • "cardNumber": "1234"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get credit cards by company monitoring id

Removes a credit card from protection services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

companyMonitoringId
required
string (CompanyMonitoringId)
Example: CM|99991045

Unique identifier for a company monitoring service instance

creditCardId
required
string
Example: 1

Unique identifier for a credit card entry

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Lost and Found Stickers

Get Lost and Found Stickers

Retrieves all Lost N Found services

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get Lost and Found Stickers

Creates a new Lost N Found tracking service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
code
required
string
status
required
string (LostNFoundStickerStatus)
Enum: "NotDefined" "Active" "Churned"

Current status of the tracking sticker (e.g., active, reported lost, found)

activeTo
string <date-time>
identityNumber
required
string

Unique tracking number assigned to the physical sticker

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "status": "NotDefined",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Lost and Found Stickers by id

Retrieves details of a specific Lost N Found service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundStickerId
required
string

Unique identifier for a Lost N Found tracking service

Responses

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "data": {
    }
}

Update Lost and Found Stickers

Updates an existing Lost N Found service configuration

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundStickerId
required
string

Unique identifier for a Lost N Found tracking service

Request Body schema: application/json
code
required
string
status
required
string (LostNFoundStickerStatus)
Enum: "NotDefined" "Active" "Churned"

Current status of the tracking sticker (e.g., active, reported lost, found)

activeTo
string <date-time>
identityNumber
required
string

Unique tracking number assigned to the physical sticker

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "status": "NotDefined",
  • "activeTo": "2019-08-24T14:15:22Z",
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "data": {
    }
}

Delete Lost and Found Stickers

Permanently removes a Lost N Found service from the system

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundStickerId
required
string

Unique identifier for a Lost N Found tracking service

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Lost and Found Tags

Get Lost and Found Tags

Retrieves a list of all lost and found tags

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get Lost and Found Tags

Registers a new lost and found tag in the system

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
string or string (IdentityNumber)
code
required
string
status
required
string (LostNFoundTagStatus)
Enum: "Active" "Regret" "Shredded" "Churn" "Goodwill"
activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "code": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Lost and Found Tags by id

Retrieves detailed information for a specific lost and found tag using its ID

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundTagId
required
string
Example: 1

A unique identifier used to reference a specific lost and found tag

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Update Lost and Found Tags

Updates information for an existing lost and found tag

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundTagId
required
string
Example: 1

A unique identifier used to reference a specific lost and found tag

Request Body schema: application/json
required
string or string (IdentityNumber)
code
required
string
status
required
string (LostNFoundTagStatus)
Enum: "Active" "Regret" "Shredded" "Churn" "Goodwill"
activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "code": "string",
  • "status": "Active",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 200,
  • "data": {
    }
}

Delete Lost and Found Tags

Permanently deletes a lost and found tag from the system

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

lostNFoundTagId
required
string
Example: 1

A unique identifier used to reference a specific lost and found tag

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Firetext

Get firetext

Retrieves all Firetext subscriptions

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get firetext by id

Retrieves details of a specific Firetext subscription

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Updates a subscriptions

Updates an existing Firetext configuration

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

Request Body schema: application/json
string or string (IdentityNumber)
status
string (FiretextStatus)
Enum: "Active" "Registered" "Configure" "Regret" "Shredded" "Churn" "Goodwill" "Upgraded"
placement
string

Specifies the physical address or area where the Firetext device is located

activeTo
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string",
  • "status": "Active",
  • "placement": "string",
  • "activeTo": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Deletes a subscription

Permanently removes a Firetext subscription from the system

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Firetext Subscribers

Get Subscribers

Retrieves all subscribers associated with this Firetext service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get Subscribers

Adds a new subscriber to the Firetext service (maximum 5 subscribers per subscription)

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

Request Body schema: application/json
name
required
string
phone
required
string <phone>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Subscribers

Retrieves details of a specific subscriber (subscription limited to 5 subscribers)

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

textSubscriberId
required
string
Example: 1

Unique identifier for an individual subscriber of the Firetext service

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Subscribers

Updates information for an existing Firetext subscriber

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

textSubscriberId
required
string
Example: 1

Unique identifier for an individual subscriber of the Firetext service

Request Body schema: application/json
name
required
string
phone
required
string <phone>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "data": {
    }
}

Get Subscribers

Removes a subscriber from the Firetext notification service

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

firetextId
required
string
Example: 2

Unique identifier for a Firetext notification subscription

textSubscriberId
required
string
Example: 1

Unique identifier for an individual subscriber of the Firetext service

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0
}

Notification

sends an SMS

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required
recipients
required
Array of strings

Array of valid phone numbers, including international numbers.

message
required
string

The SMS message content.

Responses

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "statusCode": 0
}

Auth

validates password and retrieves accessible services and features

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

Request Body schema: application/json
required

The request body can contain either an username and password to validate, or just an identity number to retrieve permissions. If both are provided, the password will be validated and the permissions will be returned. If only the identity number is provided, it retrieves the permissions for that identity number.

One of
username
required
string

The personal identification number or organisation number of the entity to validate.

password
required
string

The password to validate for the given identity number.

Responses

Request samples

Content type
application/json
{
  • "identityNumber": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "statusCode": 0
}

Invoice

Get A list of a customers invoices

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

query Parameters
page
required
integer >= 1
Example: page=1

Current page number for paginated results

perPage
required
integer
Example: perPage=10

Maximum number of items to display per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "total": 0,
  • "statusCode": 0,
  • "data": [
    ]
}

Get a specific invoice by invoice number for a customer

Authorizations:
OAuth2
path Parameters
partnerId
required
string
Example: 0000

Unique identifier for the partner organization

customerId
required
string

Unique identifier for a customer record in the system

invoiceNr
required
integer <int64>

Unique identifier for an invoice record in the system

Responses

Response samples

Content type
No sample