Register a user
POST
/users Creates a user linked to the logged-in corporate or consumer identity.
Once on-boarded, a user can see and use every instrument (cards and accounts) the identity holds. If you need finer-grained permissions per user, implement them in your own application.
The new user has no password yet. Send them an invitation with Invite a user to set a password so they can set one.
Access
This operation requires a stepped-up access token. Step up before calling it by issuing a challenge through Step-up.
Request
Available on
SandboxProduction
Header parameters
Request body
*application/json
objectobject · 10 fields
Responses
200OK
Success
Headers
Body
application/json
UserUser · object · 13 fields
Response example
{ "id": "987654321", "identity": { "type": "CONSUMER", "id": "123456789" }, "name": "Alex", "surname": "Smith", "email": "[email protected]", "mobile": { "countryCode": "+44", "number": "7700900123" }, "active": true, "dateOfBirth": { "year": 1990, "month": 1, "day": 1 }, "tag": "customer-123", "countryOfResidence": "GB", "locale": "en-GB", "brand": "Acme", "roles": [ "CARD_ASSIGNEE" ]}