Update a user

put

https://sb-api.xpollens.com/api/v2.0/users/{AppUserId}

Description

This endpoint allows the partner to update the information of a user (regardless of its role):

Client
Legal representative
Beneficial owner
Mandated

The fields Address, PhoneNumber and Email are optional for non Mandated contributors.

If the User’s Identity diligence has a Validated status, then these fields cannot be updated anymore :

Civility
FirstName
LastName
BirthName
BirthDate
BirthCity
BirthCountry
Nationality

Moreover, if the userRecordStatus is Validated, strong authentication must be used. Please use the URI below:

[PUT] /api/sca/v2.0/users/{AppUserId}

Prerequisite

Prerequisites to call this endpoint are:

The user has not completely finished its onboarding (the userRecordStatus <> validated).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

AppUserId

string

required

User identifier from the Partner.

Format: min 6 characters, max 30 characters

Accepted characters: 0-9 a-z A-Z _ - . ! § ( )

Regex: ^[a-zA-Z0-9-_.!§)(]*$

Body Params

User profile Information

profile

object

required

User to update profile

Headers

CorrId

string

Defaults to fd083d07-7f48-44e6-94d3-f4d04bbac6cf

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200

User updated successfully

Description
Incorrect or already taken telephone number
Date of birth invalid
The user must be over 18 years old
Incorrect or already taken e-mail
The city and zipCode length mustn't exceed 38 char
The street length mustn't exceed 38 char
The supplementIn length mustn't exceed 38 char
The supplementOut length mustn't exceed 38 char
The area length mustn't exceed 38 char
'Address. Country' is not in the correct format.

Description
userRecordStatus validated. Operation not authorised.
User with identity already validated cannot be updated; 'Civility', 'FirstName', 'LastName', 'Birthdate', 'BirthCountry', 'BirthCity' and 'Nationality' cannot be modified.
User under identity validation cannot be updated; 'Civility', 'FirstName', 'LastName', 'Birthdate', 'BirthCountry', 'BirthCity' and 'Nationality' cannot be modified.

404 Not Found: DescriptionUser cannot be found

500Internal Server Error