API REFERENCE · SCHEMA
ScreeningPolicySnapshot 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 schemasnameRequired- string
Minimum length: 2. Maximum length: 120.
purposeRequired- string
Minimum length: 3. Maximum length: 1000.
jurisdictionsRequired- string[]
Minimum items: 1. Maximum items: 30.
jurisdictions item fields
Each array item: string.
Minimum length: 2. Maximum length: 100.
requiredSourcesRequired- object
Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.
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.
optionalSourcesRequired- object
Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.
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.
exclusionsRequired- string[]
Maximum items: 30. Default: [].
exclusions item fields
Each array item: string.
Minimum length: 3. Maximum length: 500.
externalChecksRequired- string[]
Maximum items: 20. Default: [].
externalChecks item fields
Each array item: string.
Minimum length: 3. Maximum length: 200.
externalCheckGuidanceOptional- object[]
Maximum items: 20.
externalCheckGuidance item fields
Each array item: object.
externalCheckGuidance[]Required.label - string
Minimum length: 3. Maximum length: 200.
externalCheckGuidance[]Required.instructions - string
Minimum length: 3. Maximum length: 2000.
externalCheckGuidance[]Optional.evidenceExample - string
Minimum length: 3. Maximum length: 1000.
Additional fields are not accepted.
reviewRequired- object
Default: {}.
review fields and rules
reviewOptional.requireSecondReview - boolean
Default: false.
reviewOptional.secondReviewFor - string[]
Maximum items: 4. Default: [].
review.secondReviewFor item fields
Each array item: string.
Values: "same_identity", "allow", "restrict", "escalate".
reviewOptional.approverRoles - string[]
Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].
review.approverRoles item fields
Each array item: string.
Values: "owner", "admin", "analyst".
Additional fields are not accepted.
monitoringIntervalHoursRequired- 6 or 24 or 168
Default: 24.
monitoringIntervalHours fields and rules
Allowed alternatives
- 6
Must equal 6.
- 24
Must equal 24.
- 168
Must equal 168.
- 6
retentionTriggerRequired- string
Values: "review_completed", "relationship_ended", "business_event". Default: "review_completed".
idRequired- string
Format: uuid.
versionRequired- integer
Minimum: 0.
environmentRequired- string
Values: "sandbox", "production".
createdAtRequired- string
Format: date-time.
Additional fields are not accepted.