Register an identity

POST https://api.jsonpad.io/identities/register

Example

1234567891011

curl https://api.jsonpad.io/identities/register \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -H "x-identity-token: <IDENTITY TOKEN>" \
  -H "x-identity-group: <IDENTITY GROUP>" \
  -d '{
        "name": "My New Identity",
        "group": "sample-group",
        "email": "identity@example.com",
        "password": "correct-horse"
      }'

Parameters

No parameters

Request headers

required
x-api-tokenstringYour API token.
optional
x-identity-tokenstringAn identity token.
optional
x-identity-groupstringAn identity group.

Request body

{group: "sample-group"
name: "Sample Identity"
displayName: "Sample Display Name"
email: "identity@example.com"
password: "correct-horse"
}

optional
groupstringThe identity's group. This can be used to associate identities with a particular app or project, and helps to avoid name conflicts.
optional
namestringThe name of the identity.
optional
displayNamestringA public name for the identity, e.g. to show who created an item. Unlike the name, this isn't used for logging in.
optional
emailstring | null
The identity's email address. Email addresses are unique within a group (ignoring case), and can be used instead of the name to log in. Required if the identity's group requires an email address.
optional
passwordstring
The identity's password.
New passwords must be at least 8 characters, and at most 72 bytes, long.

Response body

200 OK

{id: "745cc769-610a-49f4-979a-5986d0d3151d"
createdAt: "2026-10-07T22:12:43.725Z"
updatedAt: "2026-10-07T22:12:43.725Z"
user: {id: "424a8673-ac3b-4f4f-b612-40664c361a4d"
createdAt: "2026-10-07T22:12:43.725Z"
updatedAt: "2026-10-07T22:12:43.725Z"
lastActiveAt: "2026-10-07T22:12:43.725Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample Identity"
displayName: "Sample Display Name"
email: "identity@example.com"
emailVerified: false
hasPassword: true
tags: [0: "my-app"
]
group: "sample-group"
activated: true
}

Response headers

locationhttps://api.jsonpad.io/identities/566af1fb-e8e9-456b-80f3-8c47f85d461bThe URL of the newly created identity.
last-modified2026-10-07T22:12:43.725ZThe date this identity was last modified.

2026-09-17