Skip to main content
POST
/
users
Onboard a user in the authenticated tenant.
curl --request POST \
  --url https://test.didxtech.com/consumer-onboarding/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "externalIdentifier": "PARTNER-ID-12345"
}
'
{
  "data": {
    "email": "[email protected]",
    "tempPassword": "Test@12345"
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "related": "<string>"
  },
  "meta": {},
  "errors": [
    {
      "detail": "<string>",
      "id": "<string>",
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.didx.co.za/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

At least one of email or username must be provided.

​
email
string<email>
​
username
string
Minimum string length: 1
Pattern: ^[a-zA-Z0-9._-]+$
​
firstName
string
​
lastName
string
​
externalIdentifier
string
Minimum string length: 1

Response

User onboarded successfully.

​
data
object
required
Example:
{
  "email": "[email protected]",
  "tempPassword": "Test@12345"
}
​
links
object
​
meta
object
​
errors
object[]