POST
/
v1
/
learning
/
onboarding
/
parent-child
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.traceLearn.completeTraceLearnParentChildOnboarding({
  body: {},
})
{
  "actor": {
    "actorId": "<string>",
    "displayName": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>",
    "studentId": "<string>",
    "learnerKey": "<string>",
    "adminGrants": []
  },
  "profile": {
    "displayName": "<string>",
    "organizationId": "<string>",
    "teamId": "<string>",
    "studentId": "<string>"
  },
  "student": {
    "id": "<string>",
    "displayName": "<string>",
    "avatarId": "<string>",
    "targetSchool": "<string>",
    "learnerKey": "<string>",
    "credential": {
      "username": "<string>",
      "pinSet": true,
      "credentialKind": "student_username_pin"
    }
  },
  "links": [
    {
      "id": "<string>",
      "studentId": "<string>"
    }
  ],
  "entitlement": {},
  "firstDestination": "<string>",
  "nextSteps": [
    "<string>"
  ],
  "principal": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "roles": [],
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "permissions": []
  }
}

Body

application/json
parentDisplayName
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
parentEmail
string
required

a string at most 254 character(s) long

Required string length: 3 - 254
childDisplayName
string
required

a string at most 160 character(s) long

Required string length: 1 - 160
childPin
string
required

a string matching the pattern ^[0-9]{4}$

Pattern: ^[0-9]{4}$
yearGroup
enum<string>
required
Available options:
Year 4,
Year 5,
Year 6,
Other
childUsername
string

a string at most 128 character(s) long

Required string length: 1 - 128
targetSchool
string | null

a string at most 160 character(s) long

Maximum string length: 160
examFamilyId
string

a string at most 128 character(s) long

Required string length: 1 - 128
subjectIds
enum<string>[]
Available options:
maths,
english,
verbal-reasoning,
non-verbal-reasoning
avatarId
string

a string at most 128 character(s) long

Required string length: 1 - 128
addDiagnosticAssignment
boolean
idempotencyKey
string<uuid>

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
tutorInviteEmail
string | null

a string at most 254 character(s) long

Maximum string length: 254
anonymousDiagnostic
object

Response

Success

actor
object
required
profile
object
required
student
object
required
entitlement
object
required
firstDestination
string
required
nextSteps
string[]
required
principal
object
required
claimOutcome
enum<string> | null
Available options:
claimed,
already_claimed,
unavailable,
expired,
not_found,
not_completed