API REFERENCE · SCHEMA

PolicyList schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas
itemsRequired
ScreeningPolicySnapshot[]
items item fields

Each array item: ScreeningPolicySnapshot.

items[].nameRequired
string

Minimum length: 2. Maximum length: 120.

items[].purposeRequired
string

Minimum length: 3. Maximum length: 1000.

items[].jurisdictionsRequired
string[]

Minimum items: 1. Maximum items: 30.

items[].jurisdictions item fields

Each array item: string.

Minimum length: 2. Maximum length: 100.

items[].requiredSourcesRequired
object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

items[].requiredSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

items[].optionalSourcesRequired
object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

items[].optionalSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

items[].exclusionsRequired
string[]

Maximum items: 30. Default: [].

items[].exclusions item fields

Each array item: string.

Minimum length: 3. Maximum length: 500.

items[].externalChecksRequired
string[]

Maximum items: 20. Default: [].

items[].externalChecks item fields

Each array item: string.

Minimum length: 3. Maximum length: 200.

items[].externalCheckGuidanceOptional
object[]

Maximum items: 20.

items[].externalCheckGuidance item fields

Each array item: object.

items[].externalCheckGuidance[].labelRequired
string

Minimum length: 3. Maximum length: 200.

items[].externalCheckGuidance[].instructionsRequired
string

Minimum length: 3. Maximum length: 2000.

items[].externalCheckGuidance[].evidenceExampleOptional
string

Minimum length: 3. Maximum length: 1000.

Additional fields are not accepted.

items[].reviewRequired
object

Default: {}.

items[].review fields and rules
items[].review.requireSecondReviewOptional
boolean

Default: false.

items[].review.secondReviewForOptional
string[]

Maximum items: 4. Default: [].

items[].review.secondReviewFor item fields

Each array item: string.

Values: "same_identity", "allow", "restrict", "escalate".

items[].review.approverRolesOptional
string[]

Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].

items[].review.approverRoles item fields

Each array item: string.

Values: "owner", "admin", "analyst".

Additional fields are not accepted.

items[].monitoringIntervalHoursRequired
6 or 24 or 168

Default: 24.

items[].monitoringIntervalHours fields and rules

Allowed alternatives

  • 6

    Must equal 6.

  • 24

    Must equal 24.

  • 168

    Must equal 168.

items[].retentionTriggerRequired
string

Values: "review_completed", "relationship_ended", "business_event". Default: "review_completed".

items[].idRequired
string

Format: uuid.

items[].versionRequired
integer

Minimum: 0.

items[].environmentRequired
string

Values: "sandbox", "production".

items[].createdAtRequired
string

Format: date-time.

Additional fields are not accepted.

requirePolicyRequired
boolean
nextCursorRequired
string or null

May be null.

nextCursor fields and rules

Allowed alternatives

  • string
  • null

    May be null.