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 schemasitemsRequired- ScreeningPolicySnapshot[]
items item fields
Each array item: ScreeningPolicySnapshot.
items[]Required.name - string
Minimum length: 2. Maximum length: 120.
items[]Required.purpose - string
Minimum length: 3. Maximum length: 1000.
items[]Required.jurisdictions - string[]
Minimum items: 1. Maximum items: 30.
items[].jurisdictions item fields
Each array item: string.
Minimum length: 2. Maximum length: 100.
items[]Required.requiredSources - 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[]Required.optionalSources - 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[]Required.exclusions - string[]
Maximum items: 30. Default: [].
items[].exclusions item fields
Each array item: string.
Minimum length: 3. Maximum length: 500.
items[]Required.externalChecks - string[]
Maximum items: 20. Default: [].
items[].externalChecks item fields
Each array item: string.
Minimum length: 3. Maximum length: 200.
items[]Optional.externalCheckGuidance - object[]
Maximum items: 20.
items[].externalCheckGuidance item fields
Each array item: object.
items[]Required.externalCheckGuidance[] .label - string
Minimum length: 3. Maximum length: 200.
items[]Required.externalCheckGuidance[] .instructions - string
Minimum length: 3. Maximum length: 2000.
items[]Optional.externalCheckGuidance[] .evidenceExample - string
Minimum length: 3. Maximum length: 1000.
Additional fields are not accepted.
items[]Required.review - object
Default: {}.
items[].review fields and rules
items[]Optional.review .requireSecondReview - boolean
Default: false.
items[]Optional.review .secondReviewFor - string[]
Maximum items: 4. Default: [].
items[].review.secondReviewFor item fields
Each array item: string.
Values: "same_identity", "allow", "restrict", "escalate".
items[]Optional.review .approverRoles - 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[]Required.monitoringIntervalHours - 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.
- 6
items[]Required.retentionTrigger - string
Values: "review_completed", "relationship_ended", "business_event". Default: "review_completed".
items[]Required.id - string
Format: uuid.
items[]Required.version - integer
Minimum: 0.
items[]Required.environment - string
Values: "sandbox", "production".
items[]Required.createdAt - 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.