Skip to main content
POST
/
users
/
apikeys
Create API key
curl --request POST \
  --url https://sandbox-api.anzi.finance/v1/users/apikeys \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@company.com",
  "password": "your-password",
  "name": "LMS Integration Key"
}
'
{
  "uid": "8f5a1b2c-3d4e-5f6a-9b8c-0d1e2f3a4b5c",
  "name": "LMS Integration Key",
  "status": 0,
  "key": "ANZI.xxxxxx.yyyyyy.zzzzzz"
}

​
Prerequisites

You must have an Anzi user with access to the corresponding environment. If you don’t have an account and want to try Anzi’s guarantee solutions, let’s schedule a call.
The returned key is shown only once. Store it securely and use it as X-API-KEY in your requests.
Rate limit: You can create up to 5 API keys per hour.

Body

application/json
​
email
string<email>
required

Anzi account email for the selected environment

Example:

"user@company.com"

​
password
string<password>
required

Password assigned by Anzi for the selected environment

Example:

"your-password"

​
name
string
required

Human-friendly name for the API key. Must be 3-50 characters; allowed characters letters, numbers, spaces, hyphens, underscores and periods.

Required string length: 3 - 50
Pattern: ^[a-zA-Z0-9\-_. ]+$
Example:

"LMS Integration Key"

Response

API key created

Returned only once. Store the key securely; it will not be shown again.

​
uid
string
​
name
string
​
status
enum<integer>

0 = ACTIVE, 1 = INACTIVE

Available options:
0,
1
​
key
string

Plain API key value to be used as X-API-KEY