Claim child

POST: a parent claims an existing child's username.

POST /++claim_child

Parent Experience

Authentication

Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
client_token — A client token issued at registration time is supplied with the request.

Request

Content type: application/json

Name	In	Type	Required	Description
`BODY`	body	string	No	—
`child_username`	body	string	No	—

Example request body

{
  "BODY": "example_value",
  "child_username": "example_value"
}

Responses

Status	Meaning
`200`	Successful response.
`201`	Created successfully.
`400`	Invalid JSON body.
`403`	Only parents can claim a child.
`404`	No student account found with that username.
`409`	A link with this child already exists.
`401`	Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).

Example response (illustrative - field names only, values are placeholders)

{
  "child_username": "example_value",
  "status": "published",
  "class_title": "Sample Title",
  "errors": "example_value"
}

Parent Experience