Skip to main content
POST
/
v1
/
beneficiaries
Beneficiary creation
curl --request POST \
  --url https://api.opx.co/partners/v1/beneficiaries \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "city": "<string>",
  "zipcode": "<string>",
  "email": "[email protected]",
  "firstname": "<string>",
  "lastname": "<string>",
  "company_name": "<string>",
  "siren": "<string>",
  "siret": "<string>",
  "country": "<string>",
  "mobile_phone": "<string>",
  "phone": "<string>",
  "convention_id": 123
}
'
{
  "data": {
    "id": 123,
    "firstname": "<string>",
    "lastname": "<string>",
    "company_name": "<string>",
    "siren": "<string>",
    "siret": "<string>",
    "address": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "mobile_phone": "<string>",
    "phone": "<string>",
    "email": "<string>"
  }
}

Body

application/json
​
address
string
required
Maximum string length: 255
​
city
string
required
Maximum string length: 255
​
zipcode
string
required
​
email
string<email>
required
Maximum string length: 255
​
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
​
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