API Reference

Create a Collaborator 🌍

post
https://partner-api.payfit.com/companies//collaborators

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the company

Body Params
string
required

First name of the employee.

string
required

Last name of the employee.

string

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".

string
required

Personal email of the employee.

string

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

personalAddress
object

Personal address of the employee.

birthInformation
object

Birth information of the employee.

string

Personal phone number of the employee.

number
0 to 20

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

string
enum

Gender of the employee.

Allowed:
boolean
Defaults to false

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.

Responses

Updated 7 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago