Skip to main content

FulfilRecordRequestDto

items object[]required

Typed records released to the regulator (entity kind + id).

  • Array [
  • entityKindstringrequired

    Possible values: [referral, policy, claim, payment, commission, audit_event, client, agent]

    entityIdstringrequired
    releaseNotestring

    Per-item release note (query used, redaction level, etc.).

    Possible values: <= 500 characters

  • ]
  • attachedNotestring

    Note included in the fulfilment audit event.

    Possible values: >= 3 characters and <= 1000 characters

    FulfilRecordRequestDto
    {
    "items": [
    {
    "entityKind": "referral",
    "entityId": "string",
    "releaseNote": "string"
    }
    ],
    "attachedNote": "string"
    }