DoCurious API Reference / types / AccountLinkage

Interface: AccountLinkage

Defined in: types/user.types.ts:228

Represents a parent-child, guardian-ward, or school-student account linkage.

Remarks

Linkages drive COPPA consent flows and Tier 2 feature unlocking. When a linkage is in pending status, automatic reminder emails are dispatched at day 14 and day 28 before the approval deadline expires.

Example

ts

const linkage: AccountLinkage = {
  id: 'lnk-001',
  createdAt: '2025-09-01T10:00:00Z',
  updatedAt: '2025-09-01T10:00:00Z',
  parentUserId: 'usr-parent-01',
  childUserId: 'usr-child-01',
  linkageType: 'parent_child',
  status: 'active',
  consentGranted: true,
  consentGrantedAt: '2025-09-02T14:00:00Z',
  reminderSentDay14: false,
  reminderSentDay28: false,
}

Extends

BaseEntity

Properties

approvalDeadline?

optional approvalDeadline: string

Defined in: types/user.types.ts:246

ISO datetime by which the parent must approve the linkage before it expires

childUserId

childUserId: string

Defined in: types/user.types.ts:232

The child/student user in this relationship

consentGranted

consentGranted: boolean

Defined in: types/user.types.ts:237

consentGrantedAt?

optional consentGrantedAt: string

Defined in: types/user.types.ts:238

consentRevokedAt?

optional consentRevokedAt: string

Defined in: types/user.types.ts:239

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt

id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id

linkageType

linkageType: LinkageType

Defined in: types/user.types.ts:233

parentUserId

parentUserId: string

Defined in: types/user.types.ts:230

The parent/guardian user in this relationship

reclaimDeadline?

optional reclaimDeadline: string

Defined in: types/user.types.ts:248

ISO datetime by which a severed link can be reclaimed

reminderSentDay14

reminderSentDay14: boolean

Defined in: types/user.types.ts:250

Whether the 14-day reminder email has been sent

reminderSentDay28

reminderSentDay28: boolean

Defined in: types/user.types.ts:252

Whether the 28-day reminder email has been sent

sharingPermissions?

optional sharingPermissions: SharingPermissions

Defined in: types/user.types.ts:242

Parent-controlled sharing rules; only relevant for Tier 2 under-13 accounts

status

status: LinkageStatus

Defined in: types/user.types.ts:234

updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt