Skip to main content

User Profile

The profile is a collection of inputs from, or about the User.

Contacts

One of inputs is the contacts, which are information about people linked to the user. These contacts may be used for example if you want different names to appear on the authorization request page of data connections.

GET/api/v6/users/{userId}/profile/contacts

List the contacts of a user with this endpoint.

POST/api/v6/users/{userId}/profile/contacts

Create a new contact for the user with this endpoint.

FieldTypeDescription
iduuidUnique id of the user
referencestringThis field must indicate who the contact is (i.e.: "manager", "requester", "accountant", etc...). This field is left to the client. If multiple contacts share the same reference for a user, which one would then be selected for that reference is undefined
namestringComplete name of the contact (company name, full name, possibly with a title).
first_namestringFirst name of the person
last_namestringLast name of the person
birth_datestringBirth date of the contact
registration_numberstringRegistration number of the contact (i.e.: siren)
addressAddressAddress of the contact
phone_numbersstring[]Phone numbers of the contact
emailsstring[]emails