Create Identifier

POST https://api.sonorancad.com/v2/emergency/accounts/{accountUuid}/identifiers

Rate limit: 10 requests per minute
Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Create a new identifier for an account.

Path Parameters

Name	Type	Description
`accountUuid`	string (uuid)	Sonoran CAD account UUID.

Request Body

All identifier properties are optional in the backend. If omitted, the server uses the defaults shown below.

Property	Type	Required	Default	Description
`status`	integer	No	`0`	Initial identifier status. See `UNIT_STATUS` below.
`aop`	string	No	`""`	Optional area of patrol string.
`unitNum`	string	No	`"NEW UNIT"`	Displayed unit number.
`name`	string	No	`"NO NAME"`	Identifier display name.
`district`	string	No	`"NOT SET"`	District name.
`department`	string	No	`"NOT SET"`	Department name.
`subdivision`	string	No	`"NOT SET"`	Subdivision name.
`rank`	string	No	`"NOT SET"`	Rank label.
`group`	string	No	`""`	Optional persistent group name.
`page`	integer	No	`-1`	CAD page enum. See `UNIT_PAGE` below.
`isDispatch`	boolean	No	`false`	Marks the identifier as a dispatcher.

{
  "status": 0,
  "aop": "Los Santos",
  "unitNum": "A-10",
  "name": "John Doe",
  "district": "Los Santos",
  "department": "LSPD",
  "subdivision": "Patrol",
  "rank": "Officer",
  "group": "CAR-51",
  "page": 0,
  "isDispatch": false
}

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:createIdentifierV2('00000000-0000-0000-0000-000000000000', {
    status = 0,
    unitNum = '1A-01',
    name = 'John Doe',
    department = 'Police',
    subdivision = 'Patrol',
    rank = 'Officer',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the Lua export client:

local response = cad:createIdentifierV2('00000000-0000-0000-0000-000000000000', {
    status = 0,
    unitNum = '1A-01',
    name = 'John Doe',
    department = 'Police',
    subdivision = 'Patrol',
    rank = 'Officer',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.createIdentifierV2('00000000-0000-0000-0000-000000000000', {
    status: 0,
    unitNum: '1A-01',
    name: 'John Doe',
    department: 'Police',
    subdivision: 'Patrol',
    rank: 'Officer',
  });
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.createIdentifierV2('00000000-0000-0000-0000-000000000000', {
    "status": 0,
    "unitNum": '1A-01',
    "name": 'John Doe',
    "department": 'Police',
    "subdivision": 'Patrol',
    "rank": 'Officer',
  })

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.createIdentifierV2(
    "00000000-0000-0000-0000-000000000000",
    new IdentifierV2Request
    {
        UnitNum = "1A-01",
        Department = "Police",
        Subdivision = "Patrol",
        Callsign = "Adam 1",
        Title = "Officer John Doe",
        Type = "LEO",
        IsPrimary = true
    }
);

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Create Identifier"
  version: "1.0.0"
  description: "Create a new identifier for an account."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/emergency/accounts/{accountUuid}/identifiers:
    post:
      summary: "Create Identifier"
      operationId: "createIdentifier"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                identId: 42
      parameters:
        -
          description: "Sonoran CAD account UUID."
          name: "accountUuid"
          in: "path"
          schema:
            type: "string"
          required: true
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              status: 0
              aop: "Los Santos"
              unitNum: "A-10"
              name: "John Doe"
              district: "Los Santos"
              department: "LSPD"
              subdivision: "Patrol"
              rank: "Officer"
              group: "CAR-51"
              page: 0
              isDispatch: false
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request POST \
  --url "https://api.sonorancad.com/v2/emergency/accounts/00000000-0000-0000-0000-000000000000/identifiers" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "status": 0,
  "aop": "Los Santos",
  "unitNum": "A-10",
  "name": "John Doe",
  "district": "Los Santos",
  "department": "LSPD",
  "subdivision": "Patrol",
  "rank": "Officer",
  "group": "CAR-51",
  "page": 0,
  "isDispatch": false
}'

Response

Successful requests return application/json.

{
  "identId": 42
}

Enumeration Values

UNIT_STATUS

Value	Description
`0`	`UNAVAILABLE`
`1`	`BUSY`
`2`	`AVAILABLE`
`3`	`ENROUTE`
`4`	`ON_SCENE`
`100`	`OFFLINE`

UNIT_PAGE

Value	Description
`0`	`POLICE`
`1`	`FIRE`
`2`	`EMS`
`3`	`DISPATCH`
`-1`	`UNKNOWN`

Start here

Tutorials

Integration Capabilities

Pricing

Roadmap

Other

Path Parameters

Request Body

Example Request

Response

Enumeration Values

UNIT_STATUS

UNIT_PAGE

​Path Parameters

​Request Body

​Example Request

​Response

​Enumeration Values

​UNIT_STATUS

​UNIT_PAGE

Path Parameters

Request Body

Example Request

Response

Enumeration Values

UNIT_STATUS

UNIT_PAGE