Create shadow user

post

https://api.preprod.rofim.doctor/services/interoperability/users/shadow

Creates a shadow user in the system. Shadow users are users created by an interoperable client that exist only in the context of that client. If a user with the same externalId already exists, the existing user will be returned without creating a new one. The matching is done based on the externalId field, which must be unique per interoperable client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

required

External identifier for the user

accountType

string

enum

required

Type of account

Allowed:

firstName

string

required

User's first name

lastName

string

required

User's last name

address

object

required

specialty

string

Medical specialty (required for "medecin" account type). You can specify either the full name of the specialty (e.g., "Cardiologue") or the corresponding specialty code (SM code) as defined in the French healthcare system. This field is mandatory when accountType is set to "medecin".

occupation

string

enum

Professional occupation (required for "paramedical" account type). This field is mandatory when accountType is set to PARAMEDICAL.

status

array of strings

Professional status of the user (required for "medecin" account type). You can specify multiple statuses if applicable. If not provided for a "medecin" account, it defaults to "liberal doctor".

status

rpps

string

^\d{11}$

Healthcare Professional unique identifier (RPPS, ADELI or AM, 11 digits). MUST be sent as a JSON string (with quotes).

foreignRpps

string

Foreign healthcare professional identifier, used when the user is not registered in the French RPPS directory. Mutually exclusive with rpps, billingId and finess.

billingId

string

Adeli/AM identifier

finess

string

FINESS number (required if rpps and billingId are not provided)

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created shadow user

400Bad Request - Invalid input

401Unauthorized

403Forbidden - Client does not have the CREATE_SHADOW_USER permission