SuperdindaDocs
Seats

Set the dependent

PUT
/seats/{uid}/dependent

Who the seat observes: name, birth date, relationship to the caller, phone (to be paired) and document (keys the relationship check). Re-run to correct. A change while the consent link is open withdraws it (send a new one); once the dependent said yes the details are locked (422 DEPENDENT_LOCKED). Resubmitting the same details changes nothing.

Authorization

Bearer
headerAuthorizationBearer <JWT>

Path Parameters

uid*string

seat uid

Formatuuid

Request Body

application/json
  1. body
kind?string

minor = child under 18; adult = grown person under care

Default"minor"
Value in"minor""adult"
name*string

how the guardian calls the dependent

Length1 <= length <= 120
birthDate*string

YYYY-MM-DD

Formatdate
relationship*string

how the guardian filling this in relates to the dependent: parent means the dependent is their parent

Value in"child""grandchild""niece_nephew""sibling""parent""grandparent""aunt_uncle""spouse""parent_in_law""child_in_law""other"
phone*string

E.164 — the WhatsApp that will be paired and where the consent link is sent

Match^\+[1-9]\d{6,14}$
document*

required: the relationship check keys on it; cpf is check-digit validated

Response Body

The seat with its dependent

application/json
  1. response
success*true
Value intrue
data*
Example Request
curl -X PUT 'http://localhost:3000/seats/497f6eca-6276-4993-bfeb-53cbbbba6f08/dependent' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "birthDate": "2019-08-24",  "relationship": "child",  "phone": "string",  "document": {    "type": "cpf",    "number": "string"  }}'
Example Response
{  "success": true,  "data": {    "uid": "string",    "status": "pending",    "price": {      "uid": "string",      "amountCents": 0,      "currency": "string",      "interval": "month",      "campaignCode": "string"    },    "dependent": {      "kind": "minor",      "name": "string",      "birthDate": "2019-08-24",      "relationship": "child",      "phone": "string",      "document": {        "type": "cpf",        "number": "string"      }    },    "attested": true,    "consent": {      "status": "pending",      "requestedAt": "2019-08-24T14:15:22Z",      "givenAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "sentAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "openedAt": "2019-08-24T14:15:22Z",      "declinedAt": "2019-08-24T14:15:22Z",      "resendAvailableAt": "2019-08-24T14:15:22Z",      "revokedAt": "2019-08-24T14:15:22Z",      "revokedBy": "guardian",      "deliveryChannel": "whatsapp",      "link": "string",      "needsRenewal": true    },    "backgroundCheck": {      "status": "pending"    },    "pause": {      "cause": "guardian",      "since": "2019-08-24T14:15:22Z",      "until": "2019-08-24T14:15:22Z",      "byName": "string",      "reason": "string"    },    "activatedAt": "2019-08-24T14:15:22Z",    "activationRequiresConsent": true,    "trial": {      "state": "not_started",      "startsOn": "first_connection",      "days": 0,      "startedAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z",      "label": "string"    },    "createdAt": "2019-08-24T14:15:22Z"  }}