Skip to main content
POST
Beneficiary creation

Body

application/json
address
string
required
Maximum string length: 255
city
string
required
Maximum string length: 255
zipcode
string
required
firstname
string
Maximum string length: 255
lastname
string
Maximum string length: 255
company_name
string
Maximum string length: 255
siren
string

requis uniquement si le bénéficiaire est une personne morale

siret
string

requis uniquement si le bénéficiaire est une personne morale

country
string | null
Maximum string length: 32
mobile_phone
string | null
phone
string | null
email
string<email> | null
Maximum string length: 255
convention_id
integer | null

Uniquement nécessaire pour les mandataires qui créent un bénéficiaire pour le compte d'un installateur

Response

BeneficiaryResource

data
BeneficiaryResource · object
required