Capvant

Set the directors and owners

put
https://sandbox.capvant.com/partner/v1/leads/{id}/significant-persons
PUT
/leads/{id}/significant-persons

Replaces the whole list. Who controls a business is a set, so correcting one entry must not leave the old one behind.

Authorization

AuthorizationBearer <token>

An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.

In: header

Path Parameters

id*string

The lead id returned by POST /leads.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The whole list, every time. This replaces what is held rather than adding to it.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

Shell
curl -X PUT "https://sandbox.capvant.com/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08/significant-persons" \  -H "Content-Type: application/json" \  -d '{    "significant_persons": [      {        "full_name": "string",        "date_of_birth": "string",        "residential_address": {          "line1": "string",          "postal_code": "string"        }      }    ]  }'
JSON
{  "id": "string",  "significant_persons": [    {      "full_name": "string",      "date_of_birth": "string",      "residential_address": {        "line1": "string",        "line2": "string",        "city": "string",        "region": "string",        "postal_code": "string",        "country": "string"      },      "residency_status": "homeowner",      "ownership_percent": 0    }  ],  "steps": {}}