Profiles

Manage caller profiles (personas) with data items like account numbers, postcodes, and PINs for voice-capable mapping modes.

10 endpoints

POST/profiles

Create a new profile (persona) for use in voice-capable mapping jobs.

Body Parameters

Name	Type	Required	Description
name	string	required	Display name for the profile
description	string	optional	Optional description of the profile

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Test Customer","description":"Standard UK customer persona"}' \
  https://api.nopaque.co.uk/profiles

Response

json

{
  "id": "prof_abc123",
  "name": "Test Customer",
  "description": "Standard UK customer persona",
  "createdAt": "2026-04-10T12: 00: 00Z"
}

GET/profiles

List all profiles in the workspace.

Query Parameters

Name	Type	Required	Description
limit	number	optional	Maximum items to return (default 50)
nextToken	string	optional	Pagination token from previous response

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/profiles

Response

json

{
  "profiles": [
    {
      "id": "prof_abc123",
      "name": "Test Customer",
      "createdAt": "2026-04-10T12: 00: 00Z"
    }
  ],
  "count": 1
}

GET/profiles/{id}

Get a specific profile by ID with all its items.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/profiles/prof_abc123

Response

json

{
  "id": "prof_abc123",
  "name": "Test Customer",
  "description": "Standard UK customer persona",
  "items": [
    {
      "id": "item_001",
      "label": "account_number",
      "value": "MFF123456"
    }
  ],
  "createdAt": "2026-04-10T12: 00: 00Z"
}

PUT/profiles/{id}

Update a profile.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID

Body Parameters

Name	Type	Required	Description
name	string	optional	Updated display name
description	string	optional	Updated description

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Premium Customer"}' \
  https://api.nopaque.co.uk/profiles/prof_abc123

Response

json

{
  "id": "prof_abc123",
  "name": "Premium Customer",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/profiles/{id}

Delete a profile and all its items.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/profiles/prof_abc123

Response

json

{
  "message": "Profile deleted successfully"
}

POST/profiles/{id}/items

Add an item (field/value pair) to a profile.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID

Body Parameters

Name	Type	Required	Description
label	string	required	Field label (e.g., account_number, date_of_birth)
value	string	required	Field value

Request

bash

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"account_number","value":"MFF123456"}' \
  https://api.nopaque.co.uk/profiles/prof_abc123/items

Response

json

{
  "id": "item_001",
  "profileId": "prof_abc123",
  "label": "account_number",
  "value": "MFF123456",
  "createdAt": "2026-04-10T12: 05: 00Z"
}

PUT/profiles/{id}/items/{itemId}

Update a profile item.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID
itemId	string	required	Item ID

Body Parameters

Name	Type	Required	Description
label	string	optional	Updated field label
value	string	optional	Updated field value

Request

bash

curl -X PUT -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"MFS789012"}' \
  https://api.nopaque.co.uk/profiles/prof_abc123/items/item_001

Response

json

{
  "id": "item_001",
  "value": "MFS789012",
  "updatedAt": "2026-04-10T12: 10: 00Z"
}

DELETE/profiles/{id}/items/{itemId}

Delete a profile item.

Path Parameters

Name	Type	Required	Description
id	string	required	Profile ID
itemId	string	required	Item ID

Request

bash

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/profiles/prof_abc123/items/item_001

Response

json

{
  "message": "Profile item deleted successfully"
}

GET/profiles/parameters

List all available profile parameter types.

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.nopaque.co.uk/profiles/parameters

Response

json

{
  "parameters": [
    "account_number",
    "date_of_birth",
    "postcode",
    "phone_number",
    "email"
  ]
}

GET/profiles/by-parameters

Find profiles that contain specific parameter labels.

Query Parameters

Name	Type	Required	Description
labels	string	required	Comma-separated list of parameter labels to match

Request

bash

curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.nopaque.co.uk/profiles/by-parameters?labels=account_number,postcode"

Response

json

{
  "profiles": [
    {
      "id": "prof_abc123",
      "name": "Test Customer",
      "matchedLabels": [
        "account_number",
        "postcode"
      ]
    }
  ],
  "count": 1
}