/v1/me/family

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

displayName*string

Length1 <= length <= 100

dateOfBirth*string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Formatdate

consentGuardian*true

Value in

true

consentVersion*"2026-09-24-family"

Value in

"2026-09-24-family"

Response Body

`application/json`

curl -X POST "https://example.com/v1/me/family" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "displayName": "string",    "dateOfBirth": "2019-08-24",    "consentGuardian": true,    "consentVersion": "2026-09-24-family"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "displayName": "string",  "dateOfBirth": "2019-08-24",  "status": "pending",  "requestedAt": "2019-08-24T14:15:22Z",  "canRecord": true,  "canScan": true}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

410application/json

413application/json

422application/json

428application/json

429application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`