Create an External ID
post/external-ids
This endpoint allows you to create a new temporary external ID. You need the external ID for registering a new account. We recommend using your organisation's external ID for new account creation, however we still support individual external IDs.
IMPORTANT:
For security reasons, External IDs created via the API are only valid for one hour. If you do not use it to create an account within the hour, you must generate a new external ID and start over.
SecurityApiKeyAuth
Responses
200
OK
403
Forbidden. This happens when an invalid api key is provided or the user does not have access to the api keys.
Response samples
- 200
- 403
application/json
{- "data": {
- "type": "external-ids",
- "id": "3ff84b20-0f4c-11eb-a7b7-7d9b3c0e866e",
- "attributes": {
- "valid-until": 1597041366544
}
}
}