openapi: 3.2.0 info: title: Advanced Screening and Monitoring Assessment API description: 'Dow Jones ### Rate limits Most endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes. Some endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.' version: '3' license: {} contact: {} servers: - url: API_INSTANCE security: - basicAuth: [] - jwt: [] - clientCert: [] tags: - name: Assessment description: The Assessment API allows clients to create and interact with assessments. paths: /assessment: get: summary: Get assessments description: 'Returns a paged list of assessments ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentGet tags: - Assessment parameters: - in: query name: pageSize required: false schema: type: integer - in: query name: page required: false schema: type: integer responses: '200': description: 'Returns the assessment objects with dig-basic tags removed ' content: application/json: schema: type: object allOf: - type: object required: - hasMore - total - data properties: incompleteResultSet: type: boolean description: if set to true indicates that the server did not include all name matches when the name parameter was included example: true hasMore: type: boolean description: a convenience boolean to determine whether there is more data to page through example: true total: type: number description: the total number of results available to page through example: 1035 data: type: array description: an array of assessments items: type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: data: type: array description: an array of assessments items: type: object allOf: - type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: closureDate: type: number description: assessment closure date (unix timestamp) example: 1603113059521 '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ListSearch permission) '404': description: Not found '500': description: Internal server error post: summary: Create an assessment description: 'This creates a new Assessment for a new entity, returning an assessment ID that can be used to request the status and detail of the assessment. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 325 ms | | 90th percentile | 417 ms | | 95th percentile | 484 ms | | 98th percentile | 561 ms | | 99th percentile | 651 ms | ' operationId: assessmentCreate tags: - Assessment x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 324.86 p90: 416.28 p95: 483.02 p98: 560.44 p99: 650.23 sampleSize: 50464 requestBody: required: true content: application/json: schema: type: object required: - entity - options properties: entity: type: object required: - name - entityType properties: aliases: type: array items: type: string description: Alternate names for the entity associatedCities: type: array items: type: string description: Associated cities if assessing unknown entity type associatedCountryCodes: type: array description: Country codes if assessing unknown entity type items: type: string dateOfBirth: type: string format: date description: Date of birth if assessing a person dateOfIncorporation: type: string format: date description: Date of incorporation if assessing an organisation domicileCodes: type: array description: Domicile codes if assessing a person items: type: string domiciles: type: array description: Domiciles if assessing a person items: type: string entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown externalId: type: string description: External identifier for this entity under assessment freeTextItems: type: array description: free-text key-value pairs for the entity items: type: object required: - fieldId - value properties: fieldId: type: string description: The free-text field id (or key) value: type: string description: The free-text field value gender: type: string description: Gender if assessing a person enum: - MALE - FEMALE identityNumbers: type: array description: Identity numbers for the entity items: type: object required: - type - value properties: type: type: string description: The identity number type value: type: string description: The identity number value incorporationCountry: type: string description: Country of incorporation if assessing an organisation incorporationCountryCode: type: string description: Country code for country of incorporation if assessing an organisation name: type: string description: The canonical name of an entity nationalities: type: array description: Nationalities if assessing a person items: type: string nationalityCodes: type: array items: type: string description: Nationality codes if assessing a person screeningReqID: type: string description: The screening request ID vesselCallSigns: type: array description: Call signs if assessing a vessel items: type: string vesselFlags: type: array description: Vessel flags if assessing a vessel items: type: string vesselFlagsCode: type: array description: Vessel flag codes if assessing a vessel items: type: string options: type: object description: Important options to control the assessment required: - searchType - assessmentRange - security properties: searchType: type: number description: The id of the search type the assessment will be run against precision: type: string description: Which matching strategy is used to connect the input to other entities in the system. Deprecated as searchType contains policy id that has the precision defined in it. deprecated: true assessmentRange: type: object description: The date range for the assessment to run against required: - gte - lte properties: gte: type: number description: Match to artefacts greater than this unix timestamp (milliseconds) lte: type: number description: Match to artefacts less than this unix timestamp (milliseconds) languages: type: array items: type: string description: Filter over languages of news articles during assessment. If left empty no filtering will occur security: type: object description: Security object for the assessment and anything derived from it examples: Person: value: entity: entityType: searchperson name: Bobbly Tables aliases: - Bob Tables - Robert Tables gender: MALE dateOfBirth: '1995-05-04' nationalityCodes: - US - GB domicileCodes: - US - GB associatedCities: - London - New York externalId: Reference ID nationalities: - United States of America - United Kingdom domiciles: - United States of America - United Kingdom options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Organisation: value: entity: entityType: searchorganisation name: Apple externalId: AAPL dateOfIncorporation: '1977-01-03' incorporationCountryCode: GB aliases: - Apple Inc. associatedCities: - Cupertino - San Francisco - London incorporationCountry: United Kingdom options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Vessel: value: entity: entityType: searchvessel name: Melville externalId: Melv vesselCallSigns: - WECB vesselFlagsCode: - AU aliases: - HMAS Melville associatedCities: - Sydney - Melbourne vesselFlags: - Australia options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Aircraft: value: entity: entityType: searchaircraft name: Apollo 11 externalId: ap11 associatedCountryCodes: - GB - US aliases: - AC1 options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Unknown: value: entity: entityType: searchunknown name: Bobbly Tables aliases: - Bob Tables - Robert Tables associatedCountryCodes: - GB - US associatedCities: - London - New York options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} responses: '201': description: Assessment accepted content: application/json: schema: type: object allOf: - type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: closureDate: type: number description: assessment closure date (unix timestamp) example: 1603113059521 '400': description: Your request was invalid and an assessment could not be created content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: badInput: summary: Bad Input Format value: code: BAD_INPUT_FORMAT message: 'entity.entityType must be one of: ''searchperson'', ''searchorganisation''' '401': description: Unauthenticated request '403': description: The authenticated user cannot create assessments '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_SUBMITTING_ASSESSMENT message: An error occurred submitting the assessment delete: summary: Bulk delete assessments description: '"Request to delete multiple assessments using filters" ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentBulkDelete tags: - Assessment parameters: - name: atSystemHigh in: query description: Defaults to false if not set schema: type: boolean requestBody: required: true content: application/json: schema: anyOf: - description: Delete by filters type: object allOf: - type: object allOf: - not: required: - createdBy - createdByExternalIds - not: required: - assignee - assigneeExternalIds properties: createdBy: description: Filter by created user/s internal ID/s. Cannot be used in conjunction with createdByExternalIds. oneOf: - type: integer description: Filter by created user - type: array description: Filter by created users minItems: 1 items: type: integer createdByExternalIds: description: Filter by created user/s external ID/s. Cannot be used in conjunction with createdBy. oneOf: - type: string description: Filter by created user - type: array description: Filter by created users minItems: 1 items: type: string status: description: Filter by status code/s oneOf: - type: integer description: Filter by status code - type: array description: Filter by status codes minItems: 1 items: type: integer target: description: Filter by targets type: array minItems: 1 items: type: string resultStatus: description: Filter by result status codes type: array minItems: 1 items: type: number assignee: description: Filter by assignees internal IDs. Cannot be used in conjunction with assigneeExternalIds. type: array minItems: 1 items: type: integer assigneeExternalIds: description: Filter by assignees external IDs. Cannot be used in conjunction with assignee. type: array minItems: 1 items: type: string alertTags: description: Filter by alert tags type: array minItems: 1 items: type: string - properties: skip: type: integer limit: type: integer sort: type: object anyOf: - SortCreated: type: object description: Sort by creation date properties: created: type: integer enum: - 1 - -1 - SortUpdated: type: object description: Sort by last updated date properties: updated: type: integer enum: - 1 - -1 - description: Delete by assessment ids allOf: - type: object description: Array of ids to delete properties: ids: type: array example: - AS-50 - AS-51 - AS-75 items: type: string minLength: 1 minItems: 1 - properties: skip: type: integer limit: type: integer sort: type: object anyOf: - SortCreated: type: object description: Sort by creation date properties: created: type: integer enum: - 1 - -1 - SortUpdated: type: object description: Sort by last updated date properties: updated: type: integer enum: - 1 - -1 examples: filters: value: filter: createdBy: - 100 - 200 createdByExternalIds: - john.smith@ripjar.com status: 1 assignee: - 100 skip: 1 limit: 2 ids: value: ids: - AS-51 - AS-52 - AS-70 responses: '200': description: Assessment(s) deleted content: application/json: schema: description: Delete by filters type: object properties: success: type: array items: type: object properties: name: description: Name of deleted items type: string example: entities total: description: Total deleted items type: integer warnings: description: Non fatal errors type: array items: type: object properties: id: description: Assessment id relating to the warning type: string example: AS-60 value: description: Warning value text type: string example: id does not exist example: success: - name: entities total: 7 - name: activities total: 1 - name: attachments total: 1 - name: assessments total: 1 warnings: [] '400': description: Invalid request '401': description: Unauthenticated request '403': description: The authenticated user cannot delete assessments '404': description: Assessment(s) not found '500': description: An unexpected error occurred when deleting assessment /assessment/search: post: summary: Search assessments description: 'Returns a paged list of assessments that match the given filters, sorted by the given sort criteria. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentSearch tags: - Assessment parameters: - in: query name: pageSize required: false schema: type: integer - in: query name: page required: false schema: type: integer requestBody: content: application/json: schema: type: object properties: page: type: number example: 1 default: 1 pageSize: type: number minimum: 1 maximum: 1000 default: 20 example: 10 sort: type: object properties: created: type: number enum: - -1 - 1 updated: type: number enum: - -1 - 1 closureDate: type: number enum: - -1 - 1 example: created: 1 filter: type: object allOf: - not: required: - assignee - assigneeExternalIds - not: required: - createdBy - createdByExternalIds properties: previousAssignees: type: array items: type: object allOf: - not: required: - includes - includesExternalIds - not: required: - excludes - excludesExternalIds properties: includes: type: array items: type: number description: array of internal user IDs. Cannot be used in conjunction with includesExternalIds. includesExternalIds: type: array items: type: string description: array of external user IDs. Cannot be used in conjunction with includes. excludes: type: array items: type: number description: array of internal user IDs. Cannot be used in conjunction with excludesExternalIds. excludesExternalIds: type: array items: type: string description: array of external user IDs. Cannot be used in conjunction with excludes. assignee: type: array description: return assessments currently assigned to users with these internal IDs. Cannot be used in conjunction with assigneeExternalIds. items: type: number assigneeExternalIds: type: array description: return assessments currently assigned to users with these external IDs. Cannot be used in conjunction with assignee. items: type: string types: type: array items: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown status: type: array items: description: statuses are configurable to your organisation and vary per Labyrinth Screening install type: number state: type: array items: description: the state of the assessment (-1 = ERRORED, 0 = IN_PROGRESS, 1 = NULL, 2 = CLOSED) type: number enum: - -1 - 0 - 1 - 2 createdBy: type: array description: array of internal user IDs of the users who created the assessments to include in the results. Cannot be used in conjunction with createdByExternalIds. items: type: number createdByExternalIds: type: array description: array of external user IDs of the users who created the assessments to include in the results. Cannot be used in conjunction with createdBy. items: type: string name: type: string description: Search by name entityIds: type: array description: Array of assessed entity IDs (without the "assessment:" prefix) items: type: string tags: type: array description: Array of tags; at least one tag must match for a result to be returned items: type: string dateRange: type: object properties: created: description: Timestamp range for when the assessment was created type: object properties: gte: type: number example: 1590973346512 description: cannot be used in conjunction with gt lte: type: number description: cannot be used in conjunction with lt example: 1590973346512 gt: type: number description: cannot be used in conjunction with gte example: 1590973346512 lt: type: number description: cannot be used in conjunction with lte example: 1590973346512 updated: description: Timestamp range for when the assessment was updated type: object properties: gte: type: number example: 1590973346512 description: cannot be used in conjunction with gt lte: type: number description: cannot be used in conjunction with lt example: 1590973346512 gt: type: number description: cannot be used in conjunction with gte example: 1590973346512 lt: type: number description: cannot be used in conjunction with lte example: 1590973346512 closureDate: description: Timestamp range for when the assessment was closed type: object properties: gte: type: number example: 1590973346512 description: cannot be used in conjunction with gt lte: type: number description: cannot be used in conjunction with lt example: 1590973346512 gt: type: number description: cannot be used in conjunction with gte example: 1590973346512 lt: type: number description: cannot be used in conjunction with lte example: 1590973346512 components: dateRangeProperties: gte: type: number example: 1590973346512 description: cannot be used in conjunction with gt lte: type: number description: cannot be used in conjunction with lt example: 1590973346512 gt: type: number description: cannot be used in conjunction with gte example: 1590973346512 lt: type: number description: cannot be used in conjunction with lte example: 1590973346512 example: page: 1 pageSize: 10 sort: created: 1 filter: assignee: - 10006 createdByExternalIds: - john.smith@ripjar.com state: - 1 - 0 name: John tags: - template-10007 responses: '200': description: 'Returns the assessment objects with dig-basic tags removed ' content: application/json: schema: type: object required: - hasMore - total - data properties: incompleteResultSet: type: boolean description: if set to true indicates that the server did not include all name matches when the name parameter was included example: true hasMore: type: boolean description: a convenience boolean to determine whether there is more data to page through example: true total: type: number description: the total number of results available to page through example: 1035 data: type: array description: an array of assessments items: type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ListSearch permission) '404': description: Not found '500': description: Internal server error /assessment/synchronous: post: summary: Create an assessment synchronously description: 'This creates a new Assessment for a new entity, blocking until the assessment has completed, and returning the summary form of the assessment. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 1.3 s | | 90th percentile | 2.4 s | | 95th percentile | 2.4 s | | 98th percentile | 3.5 s | | 99th percentile | 9.0 s | ' operationId: assessmentCreateSync tags: - Assessment x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 1300.49 p90: 2355.08 p95: 2355.08 p98: 3498.62 p99: 8955.12 sampleSize: 1552460 requestBody: required: true content: application/json: schema: type: object required: - entity - options properties: entity: type: object required: - name - entityType properties: aliases: type: array items: type: string description: Alternate names for the entity associatedCities: type: array items: type: string description: Associated cities if assessing unknown entity type associatedCountryCodes: type: array description: Country codes if assessing unknown entity type items: type: string dateOfBirth: type: string format: date description: Date of birth if assessing a person dateOfIncorporation: type: string format: date description: Date of incorporation if assessing an organisation domicileCodes: type: array description: Domicile codes if assessing a person items: type: string domiciles: type: array description: Domiciles if assessing a person items: type: string entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown externalId: type: string description: External identifier for this entity under assessment freeTextItems: type: array description: free-text key-value pairs for the entity items: type: object required: - fieldId - value properties: fieldId: type: string description: The free-text field id (or key) value: type: string description: The free-text field value gender: type: string description: Gender if assessing a person enum: - MALE - FEMALE identityNumbers: type: array description: Identity numbers for the entity items: type: object required: - type - value properties: type: type: string description: The identity number type value: type: string description: The identity number value incorporationCountry: type: string description: Country of incorporation if assessing an organisation incorporationCountryCode: type: string description: Country code for country of incorporation if assessing an organisation name: type: string description: The canonical name of an entity nationalities: type: array description: Nationalities if assessing a person items: type: string nationalityCodes: type: array items: type: string description: Nationality codes if assessing a person screeningReqID: type: string description: The screening request ID vesselCallSigns: type: array description: Call signs if assessing a vessel items: type: string vesselFlags: type: array description: Vessel flags if assessing a vessel items: type: string vesselFlagsCode: type: array description: Vessel flag codes if assessing a vessel items: type: string options: type: object description: Important options to control the assessment required: - searchType - assessmentRange - security properties: searchType: type: number description: The id of the search type the assessment will be run against precision: type: string description: Which matching strategy is used to connect the input to other entities in the system. Deprecated as searchType contains policy id that has the precision defined in it. deprecated: true assessmentRange: type: object description: The date range for the assessment to run against required: - gte - lte properties: gte: type: number description: Match to artefacts greater than this unix timestamp (milliseconds) lte: type: number description: Match to artefacts less than this unix timestamp (milliseconds) languages: type: array items: type: string description: Filter over languages of news articles during assessment. If left empty no filtering will occur security: type: object description: Security object for the assessment and anything derived from it examples: Person: value: entity: entityType: searchperson name: Bobbly Tables aliases: - Bob Tables - Robert Tables gender: MALE dateOfBirth: '1995-05-04' nationalityCodes: - US - GB domicileCodes: - US - GB associatedCities: - London - New York externalId: Reference ID nationalities: - United States of America - United Kingdom domiciles: - United States of America - United Kingdom options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Organisation: value: entity: entityType: searchorganisation name: Apple externalId: AAPL dateOfIncorporation: '1977-01-03' incorporationCountryCode: GB aliases: - Apple Inc. associatedCities: - Cupertino - San Francisco - London incorporationCountry: United Kingdom options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Vessel: value: entity: entityType: searchvessel name: Melville externalId: Melv vesselCallSigns: - WECB vesselFlagsCode: - AU aliases: - HMAS Melville associatedCities: - Sydney - Melbourne vesselFlags: - Australia options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Aircraft: value: entity: entityType: searchaircraft name: Apollo 11 externalId: ap11 associatedCountryCodes: - GB - US aliases: - AC1 options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} Unknown: value: entity: entityType: searchunknown name: Bobbly Tables aliases: - Bob Tables - Robert Tables associatedCountryCodes: - GB - US associatedCities: - London - New York options: searchType: 1 assessmentRange: gte: 1539505329390 lte: 1602663729390 security: {} responses: '201': description: Assessment completed content: application/json: schema: type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND '400': description: Your request was invalid and an assessment could not be created content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: badInput: summary: Bad Input Format value: code: BAD_INPUT_FORMAT message: 'entity.entityType must be one of: ''searchperson'', ''searchorganisation''' '401': description: Unauthenticated request '403': description: The authenticated user cannot create assessments '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_SUBMITTING_ASSESSMENT message: An error occurred submitting the assessment /assessment/{assessment_id}: get: summary: Retrieve an assessment description: 'The details of the assessment and summary of any results ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentSingleGet tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string responses: '200': description: Assessment detail retrieved content: application/json: schema: type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND '401': description: Unauthenticated request '403': description: The authenticated user cannot view assessments '404': description: Assessment with that ID not found '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_GETTING_ASSESSMENT message: An error occurred retrieving the assessment delete: summary: Delete an assessment description: 'Request to delete the assessment with specified id ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: AssessmentDelete tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: atSystemHigh in: query description: Defaults to false if not set schema: type: boolean responses: '204': description: Assessment deleted '400': description: Invalid request '401': description: Unauthenticated request '403': description: The authenticated user cannot delete assessments '404': description: Assessment with id not found '500': description: An unexpected error occurred when fetching the assessments /assessment/{assessment_id}/close: post: tags: - Assessment x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 294.17 p90: 754.4 p95: 1366.48 p98: 2355.08 p99: 3016.06 sampleSize: 77934 operationId: assessmentClose summary: Close an assessment description: 'An endpoint for closing assessments ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 295 ms | | 90th percentile | 755 ms | | 95th percentile | 1.4 s | | 98th percentile | 2.4 s | | 99th percentile | 3.0 s | ' parameters: - name: assessment_id in: path required: true schema: type: string requestBody: description: An object with information for closing the assessment content: application/json: schema: type: object required: - status - reason properties: comment: type: string status: type: integer reason: type: integer responses: '200': description: A response for successfully closed assessment content: application/json: schema: description: Response received when closing an assessment type: object properties: allOf: - type: object allOf: - type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: closureDate: type: number description: assessment closure date (unix timestamp) example: 1603113059521 - properties: createdBy: description: Information about the user who created the assessment type: object properties: id: description: The user's ID type: number example: 17725 username: description: The user's username type: string example: johnDoe '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ListSearch permission) '404': description: 'Not found - For example, when the reason or status do not exist, or the or assessment cannot be found. ' '412': description: 'Precondition failed - For example when the assessment has not finished or has already been closed. ' '422': description: Unprocessable entity '500': description: An unexpected error occurred while closing the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Cannot close search value: code: CLOSE_ASSESSMENT_ERROR message: 'Internal Server Error: Request failed with status code 500' /assessment/{assessment_id}/state: get: summary: Get the high-level state of the assessment description: 'Retrieve the state of the given assessment ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentState tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string responses: '200': description: Assessment State content: application/json: schema: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED '401': description: Unauthenticated request '403': description: The authenticated user cannot view assessments '404': description: Assessment with that ID not found '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_GETTING_STATUS message: An error occurred retrieving the assessment status /assessment/{assessment_id}/status: put: summary: Update the status of an assessment description: 'Update the status of an assessment ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentUpdateStatus tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string requestBody: description: An object describing the new status content: application/json: schema: type: object properties: status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 101 responses: '200': description: The updated assessment object content: application/json: schema: type: object allOf: - type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: closureDate: type: number description: assessment closure date (unix timestamp) example: 1603113059521 '400': description: Bad request '401': description: Unauthorized '403': description: Forbidden '404': description: 'Not Found - For example, the system configuration does not contain the status in the request or the assessment cannot be found. ' '422': description: 'Unprocessable Entity - For example, the status in the request is not valid to transition to from the current status. ' '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_GETTING_STATUS message: An error occurred retrieving the assessment status /assessment/{assessment_id}/assign: post: summary: Assign and change the status of the assessment description: 'Assign and change the status of the assessment ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentAssign tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string requestBody: description: An object describing the new status and assigned users delta content: application/json: schema: type: object properties: users: type: object oneOf: - required: - add - remove - required: - addExternalIds - remove - required: - add - removeExternalIds - required: - addExternalIds - removeExternalIds description: an object describing the assignee delta. if re-assigning, you must provide both as assessments can currently only have 1 assignee. properties: add: type: array description: internal user id to add. Cannot be used in conjunction with addExternalIds. items: type: number example: 10006 addExternalIds: type: array description: external user id to add. Cannot be used in conjunction with add. items: type: string example: john.smith@ripjar.com remove: type: array description: internal user id to remove. Cannot be used in conjunction with removeExternalIds. items: type: number example: 80006 removeExternalIds: type: array description: external user id to remove. Cannot be used in conjunction with remove. items: type: string example: will.smith@ripjar.com status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 102 responses: '200': description: 'Returns the updated assessment object. The updated assignees are found in the entities object. ' content: application/json: schema: type: object allOf: - type: object allOf: - type: object required: - id properties: id: type: string description: Human friendly unique identifier for this assessment example: AS-26 assessmentRange: type: object description: The date range the assessment ran against required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) precision: type: string description: assessment search precision example: torch options: type: object example: languages: [] description: The options used when the assessment was created security: type: object description: The security label applied to this assessment as per the Ripjar Security Model searchType: type: number description: the policy ID to use when determining which policies apply to this assessment example: 10002 entities: type: array items: type: object properties: name: type: string example: John Smith entityType: type: string enum: - searchperson - searchorganisation - searchvessel - searchaircraft - searchunknown example: searchperson aliases: type: array items: type: string description: Alternate names for the entity id: type: string description: Unique identifier for this entity under assessment example: assessment:3f9cbec5-a322-4b3c-9275-4d06e8737624 result: type: object properties: id: type: number example: 25514 state: type: number format: int64 description: Numerical representation of the internal alert state (e.g. opened, closed, etc). example: 2 status: type: number description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits). example: 200 reason: type: number description: A number which represents the closure reason as configured by your system administrator. example: 1 timestamp: type: number description: last updated timestamp for the internal alert comment: type: object properties: value: type: string description: comment text user: type: object properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 history: type: array description: The assignment history of the assessment items: type: object properties: assignedUsers: example: - username: John Smith email: john.smith@ripjar.com externalId: john.smith@ripjar.com mobile: 01234567890 roles: - ROLE_1 cn: john.smith@ripjar.com clientKey: lowercasekey customerExcludedApps: - app security: {} lastLogin: 1596188918065 username_lowercase: john smith lineNumber: 4 lastModified: 1595437138430 id: 10003 dateCreated: 1595437138459 oneOf: - type: array description: IDs of users assigned to the result, returned when results enrichment is disabled items: type: number example: - 1 - type: array description: Objects representing users assigned to the result, returned when results enrichment is enabled items: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 components: schemas: AssignedUserEnriched: type: object properties: username: type: string example: John Smith email: type: string example: john.smith@ripjar.com externalId: type: string example: john.smith@ripjar.com mobile: type: string example: 01234567890 roles: type: array items: type: string example: ADMINISTRATOR cn: type: string example: john.smith@ripjar.com clientKey: type: string example: lowercasekey customerExcludedApps: type: array nullable: true items: type: string example: app security: type: object lastLogin: type: number example: 1596188918065 username_lowercase: type: string example: john smith lineNumber: type: number example: 4 lastModified: type: number example: 1595437138430 id: type: number example: 1 dateCreated: type: number example: 1595437138459 timestamp: type: integer description: The timestamp for when the assessment was assigned state: type: integer description: The state code status: type: integer description: The status code assignedUsers: type: array items: type: object description: User objects for any user accounts currently assigned to the assessment properties: email: type: string example: test@ripjar.com externalId: type: string example: test@ripjar.com cn: type: string example: test@ripjar.com id: type: number example: 10006 properties: createdBy: type: object description: null properties: username: type: string description: the username for this user example: admin id: type: number description: unique identifier for this user example: 10001 clientKey: type: string description: the customer ID example: lowercasekey namespace: type: string description: system namespace example: torch label: type: string description: the name which was searched example: John Smith created: type: number description: created at (unix timestamp) example: 1603113059520 updated: type: number description: last updated at (unix timestamp) example: 1603113059520 irsVersion: type: number description: the revision the identity resolution service was at when the assessment was created example: 225670 state: type: object required: - state properties: state: type: string description: Top-level state of the assessment enum: - IN_PROGRESS - COMPLETED_NO_HITS - COMPLETED_WITH_HITS - ERRORED - CLOSED policyId: type: number description: the id for the matched policy example: 10001 tags: type: array description: Metadata related to the assessment example: - context-assessment items: type: string groupContext: type: object required: - isPrimary - groupId properties: isPrimary: type: boolean description: if this assessment is the primary one of the group example: false groupId: type: string description: id of the group example: 03b9a256-9524-4ed8-9d23-84a213793b7b relationship: type: object properties: type: type: string description: type of relationship between assessed entity and the primary assessment example: FRIEND properties: closureDate: type: number description: assessment closure date (unix timestamp) example: 1603113059521 '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ListSearch permission) '404': description: Not found '412': description: Precondition failed '422': description: Unprocessable entity '500': description: Internal server error /assessment/{assessment_id}/bulk-assess: post: summary: Bulk assess a number of pieces of evidence description: 'Bulk assess a number of pieces of evidence. They are assessed as Relevant/Not Relevant depending on the assessment codes passed in. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentBulkAssess tags: - Assessment x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 298 p90: 484.3 p95: 520.15 p98: 541.66 p99: 548.83 sampleSize: 4 parameters: - name: assessment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object required: - assessmentCodes - evidence properties: assessmentCodes: type: array description: array of assessment codes items: type: number example: - 10001 evidence: type: array description: array of evidence IDs. invalid evidence IDs are not updated. items: type: number example: - 1 comment: type: string description: an optional comment to accompany the assessment responses: '200': description: 'Returns an array of updated (partial) evidence items ' content: application/json: schema: type: array description: an array of updated (partial) evidence items items: type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the EvidenceAssess permission) '404': description: Not found '412': description: Precondition failed - the assessment must not be in progress to perform assessments '422': description: Unprocessable entity '500': description: Internal server error /assessment/{assessment_id}/evidence/{evidence_id}: get: summary: Retrieve the full content of evidence description: 'Retrieve the full content of evidence, including list profiles and article content and metadata ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceFullGet tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: evidence_id in: path required: true schema: type: number - in: query name: documentFields description: Return specific fields from the supporting evidence document. By default core.content.value and entity are returned. examples: all: value: all: true summary: Return all document fields exclude_core: value: core: false summary: Return all fields except core required: false schema: type: object allowReserved: true style: deepObject responses: '200': description: The full evidence object including the supporting document content: application/json: schema: oneOf: - allOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - risk isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com - type: object - allOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - list name: type: string description: the name of watchlist entity lists: type: array items: type: object properties: name: type: string description: the name of the watchlist example: FCA (UK) Final Notices description: type: string description: a description of the watchlist example: Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\r\nWe publish certain information about Enforcement action once a statutory notice is issued.\r\n\r\n•Warning Notices are issued when we propose to take action\r\n•Decision Notices are issued when we decide to take action\r\n•Final Notices are issued when we take action. active: type: boolean description: whether the watchlist entity is active on the list example: true id: type: string description: the watchlist ID example: dj:list:1423 listActive: type: boolean description: whether the list is active example: true sinceRange: type: object description: indicates when the entity was added to the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2005-11-24T00:00:00.000Z' end: type: string format: date-time example: '2005-11-24T23:59:59.999Z' toRange: type: object description: indicates when the entity was removed from the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2009-11-02T00:00:00.000Z' end: type: string format: date-time example: '2009-11-02T23:59:59.999Z' hierarchy: type: array description: describes the hierarchy of the watchlist items: type: object properties: name: type: string example: FCA (UK) Final Notices id: type: string example: dj:list:1423 parent: type: string example: dj:mid:4 tags: type: array items: type: string assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true - type: object '401': description: Unauthenticated request '403': description: The authenticated user cannot view assessments '404': description: Assessment with that ID not found '412': description: Precondition failed '422': description: Unprocessable entity '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_GETTING_STATUS message: An error occurred retrieving the assessment status post: summary: Retrieve the full content of evidence description: 'Retrieve the full content of evidence, including list profiles and article content and metadata ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceFullPost tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: evidence_id in: path required: true schema: type: number responses: '200': description: The full evidence object including the supporting document content: application/json: schema: oneOf: - allOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - risk isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com - type: object - allOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - list name: type: string description: the name of watchlist entity lists: type: array items: type: object properties: name: type: string description: the name of the watchlist example: FCA (UK) Final Notices description: type: string description: a description of the watchlist example: Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\r\nWe publish certain information about Enforcement action once a statutory notice is issued.\r\n\r\n•Warning Notices are issued when we propose to take action\r\n•Decision Notices are issued when we decide to take action\r\n•Final Notices are issued when we take action. active: type: boolean description: whether the watchlist entity is active on the list example: true id: type: string description: the watchlist ID example: dj:list:1423 listActive: type: boolean description: whether the list is active example: true sinceRange: type: object description: indicates when the entity was added to the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2005-11-24T00:00:00.000Z' end: type: string format: date-time example: '2005-11-24T23:59:59.999Z' toRange: type: object description: indicates when the entity was removed from the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2009-11-02T00:00:00.000Z' end: type: string format: date-time example: '2009-11-02T23:59:59.999Z' hierarchy: type: array description: describes the hierarchy of the watchlist items: type: object properties: name: type: string example: FCA (UK) Final Notices id: type: string example: dj:list:1423 parent: type: string example: dj:mid:4 tags: type: array items: type: string assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true - type: object '400': description: Bad request '401': description: Unauthenticated request '403': description: The authenticated user cannot view assessments '404': description: Assessment with that ID not found '412': description: Precondition failed '422': description: Unprocessable entity '500': description: An unexpected error occurred creating the assessment content: application/json: schema: type: object required: - code - message properties: code: type: string description: Error code that can be used when contacting support or looking up information message: type: string description: Human-readable description of the error, which will usually indicate possible next steps if applicable status: type: number description: HTTP Error code examples: unexpectedError: summary: Unexpected Error value: code: ERROR_GETTING_STATUS message: An error occurred retrieving the assessment status /assessment/{assessment_id}/evidence: post: summary: Search evidence summaries for an assessment description: 'Returns a paged list of evidence that match the given filters and sorted by the given sort criteria. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ### Operational characteristics Values below are measured from production traffic. Only collected values are shown. **Latency distribution** Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min). | Metric | Value | | --- | --- | | Median | 63 ms | | 90th percentile | 109 ms | | 95th percentile | 163 ms | | 98th percentile | 561 ms | | 99th percentile | 651 ms | ' operationId: assessmentEvidenceSearchPost tags: - Assessment x-operational-characteristics: description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z). ' latencyDistribution: median: 62.71 p90: 108.77 p95: 162.05 p98: 560.44 p99: 650.23 sampleSize: 693962 parameters: - in: query name: pageSize required: false schema: type: integer - in: query name: page required: false schema: type: integer - in: query name: convert_timestamps required: false schema: type: string enum: - 'true' - 'false' description: convert timestamps to ISO-8601 date formatted strings - name: assessment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: page: type: number example: 1 default: 1 pageSize: type: number minimum: 1 maximum: 1000 default: 20 example: 10 sort: type: object properties: matchScore: type: number enum: - -1 - 1 matchDate: type: number enum: - -1 - 1 totalRisk: type: number enum: - -1 - 1 filter: type: object example: qualification: not_assessed bookmarked: false type: list properties: dateRange: type: object properties: publication: type: object description: filter on the publication date required: - gte - lte properties: gte: type: number description: unix timestamp (lower bound) example: 1539954158521 lte: type: number description: unix timestamp (upper bound) example: 1603112558521 type: type: string description: the type of evidence enum: - risk - list example: risk assessmentCodes: type: array description: an array of assessment codes. assessment codes are defined by your system administrator. items: type: number example: - 10001 tags: type: array items: type: string example: - riskType-onList qualification: type: string description: filter by evidence qualification. can be used XOR with assessmentCodes. enum: - not_assessed - relevant - not_relevant - assessed example: not_assessed bookmarked: type: boolean description: filter by bookmarked evidence only example: false isGroupMaster: type: boolean description: filter to only include evidence which are mastered example: false responses: '200': description: 'Returns risk and list evidence ' content: application/json: schema: type: object required: - hasMore - total - data properties: hasMore: type: boolean description: a convenience boolean to determine whether there is more data to page through example: true total: type: number description: the total number of results available to page through example: 1035 data: type: array description: an array of risk or list evidence items items: anyOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - risk isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - list name: type: string description: the name of watchlist entity lists: type: array items: type: object properties: name: type: string description: the name of the watchlist example: FCA (UK) Final Notices description: type: string description: a description of the watchlist example: Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\r\nWe publish certain information about Enforcement action once a statutory notice is issued.\r\n\r\n•Warning Notices are issued when we propose to take action\r\n•Decision Notices are issued when we decide to take action\r\n•Final Notices are issued when we take action. active: type: boolean description: whether the watchlist entity is active on the list example: true id: type: string description: the watchlist ID example: dj:list:1423 listActive: type: boolean description: whether the list is active example: true sinceRange: type: object description: indicates when the entity was added to the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2005-11-24T00:00:00.000Z' end: type: string format: date-time example: '2005-11-24T23:59:59.999Z' toRange: type: object description: indicates when the entity was removed from the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2009-11-02T00:00:00.000Z' end: type: string format: date-time example: '2009-11-02T23:59:59.999Z' hierarchy: type: array description: describes the hierarchy of the watchlist items: type: object properties: name: type: string example: FCA (UK) Final Notices id: type: string example: dj:list:1423 parent: type: string example: dj:mid:4 tags: type: array items: type: string assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ViewSearch permission) '404': description: Not found '412': description: Precondition failed - the assessment must not be in progress to view results '500': description: Internal server error get: summary: Search evidence summaries for an assessment description: 'Returns a paged list of evidence that match the given filters and sorted by the given sort criteria. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceSearchGet tags: - Assessment parameters: - in: query name: pageSize required: false schema: type: integer - in: query name: page required: false schema: type: integer - in: query name: convert_timestamps required: false schema: type: string enum: - 'true' - 'false' description: convert timestamps to ISO-8601 date formatted strings - name: assessment_id in: path required: true schema: type: string responses: '200': description: 'Returns risk and list evidence ' content: application/json: schema: type: object required: - hasMore - total - data properties: hasMore: type: boolean description: a convenience boolean to determine whether there is more data to page through example: true total: type: number description: the total number of results available to page through example: 1035 data: type: array description: an array of risk or list evidence items items: anyOf: - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - risk isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com - type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: type: type: string enum: - list name: type: string description: the name of watchlist entity lists: type: array items: type: object properties: name: type: string description: the name of the watchlist example: FCA (UK) Final Notices description: type: string description: a description of the watchlist example: Publishing notices is important to ensure the transparency of Financial Conduct Authority (FCA) decision-making; it informs the public and helps maximise the deterrent effect of enforcement action.\r\nWe publish certain information about Enforcement action once a statutory notice is issued.\r\n\r\n•Warning Notices are issued when we propose to take action\r\n•Decision Notices are issued when we decide to take action\r\n•Final Notices are issued when we take action. active: type: boolean description: whether the watchlist entity is active on the list example: true id: type: string description: the watchlist ID example: dj:list:1423 listActive: type: boolean description: whether the list is active example: true sinceRange: type: object description: indicates when the entity was added to the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2005-11-24T00:00:00.000Z' end: type: string format: date-time example: '2005-11-24T23:59:59.999Z' toRange: type: object description: indicates when the entity was removed from the watchlist properties: granularity: type: string enum: - day - month - year example: day start: type: string format: date-time example: '2009-11-02T00:00:00.000Z' end: type: string format: date-time example: '2009-11-02T23:59:59.999Z' hierarchy: type: array description: describes the hierarchy of the watchlist items: type: object properties: name: type: string example: FCA (UK) Final Notices id: type: string example: dj:list:1423 parent: type: string example: dj:mid:4 tags: type: array items: type: string assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the ViewSearch permission) '404': description: Not found '412': description: Precondition failed - the assessment must not be in progress to view results '500': description: Internal server error /assessment/{assessment_id}/evidence/{evidence_id}/assess: post: summary: Assess an item of evidence in an assessment description: 'Marks an evidence item as Relevant/Not Relevant based on the assessment code passed in. Returns the assessed evidence item & activity. ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceAssess tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: evidence_id in: path required: true schema: type: number requestBody: content: application/json: schema: type: object properties: assessmentCodes: type: array required: true items: type: number example: - 10001 comment: type: string required: false responses: '200': description: 'Returns the assessed evidence item and activity entry ' content: application/json: schema: type: object properties: id: type: integer type: type: string matchScore: type: number totalRisk: type: number matchDate: oneOf: - type: string format: date description: An ISO-8601 compliant date string example: '2023-12-25' - type: integer description: Timestamp expressed as the number of milliseconds past the epoch (1970-01-01 00:00:00 UTC) isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true assessment: type: object properties: codes: type: array items: type: number description: array of assessment codes. assessment codes are configured by your system administrator. example: - 10001 timestamp: type: number description: unix timestamp which indicates when the evidence was assessed example: 1603295488656 user: type: object properties: id: type: integer example: 10006 email: type: string example: kyc.admin@ripjar.com externalId: type: string example: kyc.admin@ripjar.com cn: type: string example: kyc.admin@ripjar.com isGroupMaster: type: boolean tags: type: array items: type: string '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden (e.g. the user does not have the EvidenceAssess permission) '404': description: Not found '412': description: Precondition failed - the assessment must not be in progress to view results '422': description: Unprocessable entity '500': description: Internal server error /assessment/{assessment_id}/evidence/{evidence_id}/bookmark: post: summary: Bookmark an item of evidence in an assessment description: 'Bookmark an item of evidence in an assessment ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceBookmark tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: evidence_id in: path required: true schema: type: number responses: '200': description: 'Returns the bookmarked evidence item and activity entry ' content: application/json: schema: type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden '404': description: Not found '500': description: Internal server error delete: summary: Delete bookmark evidence in an assessment description: 'Delete bookmark evidence in an assessment ### Rate Limits This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes. ' operationId: assessmentEvidenceBookmarkDelete tags: - Assessment parameters: - name: assessment_id in: path required: true schema: type: string - name: evidence_id in: path required: true schema: type: number responses: '200': description: 'Returns the deleted evidence item and activity entry ' content: application/json: schema: type: object allOf: - type: object properties: id: type: number description: evidence ID example: 161325 matchScore: type: number description: the confidence that the match between the assessed entity and the one found in the evidence piece is correct example: 0.7002781604436024 totalRisk: type: number description: the sum of all risk for the evidence. each match reason contributes to the total risk. example: 100 matchDate: type: number description: the unix timestamp when the evidence was created example: 1603295488656 isGroupMaster: type: boolean description: indicates whether the evidence item is the master version example: true tags: type: array description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property. ' items: type: string example: - policy-20037 - risk-Financial Crime - userTag-Fin Crime-active riskTags: type: array description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags). ' items: type: string example: - PEP-active - cc42-active properties: isBookmarked: type: boolean description: indicates whether the evidence is bookmarked by the user example: true '400': description: Bad request '401': description: Unauthenticated request '403': description: Forbidden '404': description: Not found '500': description: Internal server error components: securitySchemes: jwt: type: http scheme: bearer bearerFormat: JWT description: JWT authentication is the preferred authentication method, and should be used for new integrations. Contact support to request a service account. basicAuth: type: http scheme: basic description: Basic authentication is supported for existing users, but is deprecated. Existing users are encouraged to contact support for a dedicated service account and switch to JWT authentication.