Sign in

v1

latestOpenAPI 3.0.02026-07-24310185.2 KB
Collaborator

Create a Collaborator 🌍

Create a collaborator and return its ID. The created collaborator won't have a contract, and therefore won't appear in the collaborators list in the PayFit app. In order to create a contract, use the create contract endpoint.


Required scopes: collaborators:write

post/companies/{companyId}/collaborators

Path parameters

companyIdstring required

The id of the company

Request body

firstNamestring required

First name of the employee.

lastNamestring required

Last name of the employee.

otherNamestring

Additional name information of an employee. In France it can be the "nom d'usage", in Spain it can be the "segundo apellido", in UK it can be the "middle name".

personalEmailstring required

Personal email of the employee.

socialSecurityNumberstring

Social security number of the employee. Length allowed by country: GB: 12, ES: 14, FR: 15

personalPhoneNumberstring

Personal phone number of the employee.

numberOfChildrennumber

The number of children must be an integer between 0 and 20.

gender'MALE' | 'FEMALE'

Gender of the employee.

inviteCollaboratorboolean

Whether to send an invitation email to the collaborator to access the PayFit platform. This is a beta feature and is only available for some customers for now.

Example request

{
  "personalAddress": {
    "streetNumber": 123,
    "addressFirstLine": "Avenue des Champs Elysées",
    "addressSecondLine": "Appartement 123",
    "city": "Paris",
    "state": "Île-de-France",
    "postCode": "75008",
    "country": "FR"
  },
  "birthInformation": {
    "birthCountry": "FR"
  }
}

Response

The collaborator ID.

collaboratorIdstring required