Access and authentication

The PreCrime Platform supports two authentication methods for programmatic access:

Authentication Methods

• JWT Token - Generate a token using username and password credentials

• API Key - Use a pre-configured API key for direct access

Both methods provide secure access to the platform's API endpoints and can be used depending on your integration requirements and security preferences.

JWT Authentication

PreCrime users can generate a JSON Web Token (JWT) for authentication by providing their username and password credentials.

Token Lifecycle:

• JWT tokens expire 60 minutes after generation

• Tokens can be renewed before expiration by calling the appropriate renewal endpoint

• Tokens can be manually invalidated when no longer needed

Authentication Flow:

1. Submit valid username and password credentials

2. Receive JWT token upon successful authentication

3. Include the token in subsequent API requests

4. Renew the token before expiration or generate a new one as needed

User login

post

Authenticate user and obtain JWT token

Body

application/json

usernamestringRequired

User's username

Example: john.doe

passwordstring · passwordRequired

User's password

Example: SecurePass123!

Responses

200

Successful authentication

application/json

Idstring · uuidOptionalExample: 12345678-1234-1234-1234-123456789abc

Createdstring · date-timeOptionalExample: 2023-01-15T10:30:42

UsernamestringOptionalExample: john.doe

Emailstring · emailOptionalExample: [email protected]

FirstnamestringOptionalExample: John

LastnamestringOptionalExample: Doe

TokenstringOptional

JWT token for authentication

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

PasswordExpirationstring · date-timeOptionalExample: 2024-06-15T18:30:00

401

Incorrect credentials

application/json

403

Password expired

application/json

post

/user/login

HTTPcURLJavaScriptPython

POST /user/login HTTP/1.1
Host: api.bfore.ai
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "username": "john.doe",
  "password": "SecurePass123!"
}

{
  "Id": "12345678-1234-1234-1234-123456789abc",
  "Created": "2023-01-15T10:30:42",
  "Username": "john.doe",
  "Email": "[email protected]",
  "Firstname": "John",
  "Lastname": "Doe",
  "Properties": {
    "a": "aaa",
    "b": "bbb",
    "c": "ccc"
  },
  "Authorizations": [
    {
      "Company": {
        "Id": 1,
        "Name": "Company Inc",
        "Created": "2022-05-10T09:15:20",
        "Deleted": "0001-01-01T00:00:00"
      },
      "Roles": [
        {
          "Id": 1,
          "Name": "sys-admin"
        }
      ]
    }
  ],
  "Active": {
    "Id": 1,
    "Name": "Company Inc",
    "Created": "2022-05-10T09:15:20",
    "Deleted": "0001-01-01T00:00:00"
  },
  "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "PasswordExpiration": "2024-06-15T18:30:00"
}

Renew JWT token

get

Get a new JWT token with extended expiration when current token is still valid

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

JWT token obtained from /user/login endpoint

Responses

200

New JWT token issued

application/json

tokenstringOptional

New JWT token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

401

Current token is invalid or expired

application/json

get

/user/renew

HTTPcURLJavaScriptPython

GET /user/renew HTTP/1.1
Host: api.bfore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Logout user

get

Invalidate JWT token before it expires

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

JWT token obtained from /user/login endpoint

Responses

200

Successfully logged out

application/json

messagestringOptionalExample: Success

get

/user/logout

HTTPcURLJavaScriptPython

GET /user/logout HTTP/1.1
Host: api.bfore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successfully logged out

{
  "message": "Success"
}

API Key authentication

To authenticate using an API key, follow these steps:

API Key Generation:

• API keys can be generated by getting in contact with us. Soon we will provide self service access to API key management within the platform.

Authentication Methods: API keys can be provided in two ways:

Option 1: Header Authentication Include the API key in the X-Authorization header:

GET https://api.bfore.ai/test/secure
X-Authorization: <API_KEY>

Option 2: Query Parameter Authentication Include the API key as a query parameter:

GET https://api.bfore.ai/test/secure?api_key=<API_KEY>

Both methods provide equivalent authentication and can be used based on your implementation preferences.

Add new auth header

post

Generate a new auth header token

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

JWT token obtained from /user/login endpoint

Body

application/json

namestringRequired

Name for the auth header

Example: production-api-key

Responses

200

Auth header created successfully

application/json

idstringOptional

Auth header ID

namestringOptional

Auth header name

Example: production-api-key

tokenstringOptional

Auth header token value

createdstring · date-timeOptional

Creation timestamp

post

/authheader/add

HTTPcURLJavaScriptPython

POST /authheader/add HTTP/1.1
Host: api.bfore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "production-api-key"
}

200

Auth header created successfully

{
  "id": "text",
  "name": "production-api-key",
  "token": "text",
  "created": "2026-03-28T10:22:01.745Z"
}

Get list of auth headers

get

Retrieve all available auth header tokens for the user

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

JWT token obtained from /user/login endpoint

Responses

200

List of auth headers

application/json

idstringOptional

Auth header ID

namestringOptional

Auth header name

Example: production-api-key

tokenstringOptional

Auth header token value

createdstring · date-timeOptional

Creation timestamp

get

/authheader/list

HTTPcURLJavaScriptPython

GET /authheader/list HTTP/1.1
Host: api.bfore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of auth headers

[
  {
    "id": "text",
    "name": "production-api-key",
    "token": "text",
    "created": "2026-03-28T10:22:01.745Z"
  }
]

Delete auth header

post

Delete an existing auth header token

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

JWT token obtained from /user/login endpoint

Body

application/json

textstringRequired

Auth header token to delete

Responses

200

Auth header deleted successfully

application/json

messagestringOptionalExample: Success

post

/authheader/delete

HTTPcURLJavaScriptPython

POST /authheader/delete HTTP/1.1
Host: api.bfore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "text": "text"
}

200

Auth header deleted successfully

{
  "message": "Success"
}