openapi: 3.2.0 info: title: Risk and Compliance Screening and Monitoring API description: 'RESTful API that enables your client application to screen and monitor third parties (individuals and entities) against Dow Jones Risk & Compliance data. Supports cases, associations, matches, and bulk operations. ' contact: name: Dow Jones license: name: A RESTful API that enables your client application to screen and monitor third parties - individuals and entities - against Dow Jones Risk & Compliance data. version: v7.3 servers: - url: https://api.dowjones.com - url: https://eu.api.dowjones.com tags: - name: Risk and Compliance Screening and Monitoring description: APIs for screening and monitoring third parties against Dow Jones Risk & Compliance data. paths: /risk-entity-screening-associations: get: tags: - Risk and Compliance Screening and Monitoring summary: Retrieves all associations description: Retrieves all associations for the account with optional filters and pagination. operationId: getAssociationsUsingGET parameters: - name: page[offset] in: query description: Page offset. required: false schema: type: integer format: int32 default: 0 - name: page[limit] in: query description: Page limit. required: false schema: type: integer format: int32 default: 100 - name: filter[correlated] in: query description: Filters associations by if they are correlated or not to any case. required: false schema: type: string enum: - 'true' - 'false' - any - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseListAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 - attributes: country: USA record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0 last: https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0 meta: count: 2 offset: first: '0' last: '0' total_count: 2 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/ResponseListAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 - attributes: record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: last: https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0 first: https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0 meta: count: 2 offset: last: '0' first: '0' total_count: 2 application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/ResponseListAssociationV20' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} timestamp: '2025-01-15T12:00:00' year_of_birth: specific_year: 1970 is_deceased: false type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 - attributes: country: UK record_type: PERSON names: - name_type: PRIMARY first_name: Jane last_name: Smith identification_details: {} timestamp: '2025-01-15T12:00:00' year_of_birth: from: 1980 to: 1985 gender: FEMALE external_id: ext-002 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 - attributes: country: USA record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 external_id: ext-003 timestamp: '2025-01-15T12:00:00' industry_sector: Technology type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 links: first: https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0 last: https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0 meta: count: 3 offset: last: '0' first: '0' total_count: 3 application/json: schema: $ref: '#/components/schemas/ResponseListAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 - attributes: country: USA record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0 last: https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0 meta: count: 2 offset: first: '0' last: '0' total_count: 2 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] post: tags: - Risk and Compliance Screening and Monitoring summary: Adds a new association description: 'Creates a new risk-entity-screening association for the account. When using versioned media types, the Accept and Content-Type headers must use the same version; otherwise the API returns 406 Not Acceptable. ' operationId: postAssociationUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestAssociation' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 year_of_birth: 1970 country: USA external_id: ext-001 type: risk-entity-screening-associations application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/RequestAssociationV11' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 year_of_birth: 1970 country: USA external_id: ext-001 type: risk-entity-screening-associations application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/RequestAssociationV20' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 year_of_birth: from: 1968 to: 1972 country: USA external_id: ext-001 type: risk-entity-screening-associations application/json: schema: $ref: '#/components/schemas/RequestAssociation' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 year_of_birth: 1970 country: USA external_id: ext-001 type: risk-entity-screening-associations required: true responses: '201': description: Created content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/ResponseAssociationV20' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' year_of_birth: from: 1968 to: 1972 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2025-01-15T12:00:00' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] /risk-entity-screening-associations/{association_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Retrieves an association by ID description: Returns a single association by its ID. operationId: getAssociationUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: association_id in: path description: Id of the Association. required: true schema: type: string responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-11T17:21:42' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-11T17:21:42' year_of_birth: 1970 gender: MALE is_deceased: false type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/ResponseAssociationV20' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-11T17:21:42' year_of_birth: specific_year: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponseAssociation' example: data: attributes: country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-11T17:21:42' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] delete: tags: - Risk and Compliance Screening and Monitoring summary: Removes an association description: Deletes an association by ID. Returns 204 No Content on success. operationId: deleteAssociationUsingDELETE parameters: - name: association_id in: path description: Id of the association. required: true schema: type: string responses: '204': description: No Content content: {} '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' '422': description: Unprocessable Entity content: {} security: - bearerAuth: [] patch: tags: - Risk and Compliance Screening and Monitoring summary: Modifies an association description: Partially updates an association. Returns a transaction for async status. operationId: patchAssociationUsingPATCH parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: association_id in: path description: Id of the association. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestAssociation' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe prefix: Mr suffix: Jr identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: 1970 external_id: ext-001 type: risk-entity-screening-associations application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/RequestAssociationV11' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe prefix: Mr suffix: Jr identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: 1970 external_id: ext-001 type: risk-entity-screening-associations application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/RequestAssociationV20' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe prefix: Mr suffix: Jr identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: specific_year: 1970 external_id: ext-001 type: risk-entity-screening-associations application/json: schema: $ref: '#/components/schemas/RequestAssociation' example: data: attributes: record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe prefix: Mr suffix: Jr identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: 1970 external_id: ext-001 type: risk-entity-screening-associations required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponsePatchAssociation' example: data: attributes: gender: MALE country: USA record_type: PERSON names: - prefix: Mr suffix: Jr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-12T12:02:30' updated: '2026-02-12T12:04:51.334281' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/ResponsePatchAssociation' example: data: attributes: gender: MALE country: USA record_type: PERSON names: - prefix: Mr suffix: Jr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-12T12:02:30' updated: '2026-02-12T12:04:51.334281' year_of_birth: 1970 is_deceased: false type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/ResponsePatchAssociationV20' example: data: attributes: gender: MALE country: USA record_type: PERSON names: - prefix: Mr suffix: Jr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-12T12:02:30' updated: '2026-02-12T12:04:13.891258' year_of_birth: specific_year: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponsePatchAssociation' example: data: attributes: gender: MALE country: USA record_type: PERSON names: - prefix: Mr suffix: Jr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: type: 1023 value: Passport123 external_id: ext-001 timestamp: '2026-02-12T12:02:30' updated: '2026-02-12T12:04:51.334281' year_of_birth: 1970 type: risk-entity-screening-associations links: self: https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases: get: tags: - Risk and Compliance Screening and Monitoring summary: Retrieves all cases description: 'Returns paginated cases for the account. Pagination (page[offset], page[limit]) is supported in all versions. Filters (filter[last_match_activity_on][from|to], filter[correlated]) are supported only when Accept is v1.1+ (e.g. cases.v_1.1+json). With Accept v1.0, filter params are ignored. ' operationId: getAllCasesUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: page[offset] in: query description: Page offset. Supported in all versions. required: false schema: type: integer format: int32 default: 0 - name: page[limit] in: query description: Page limit. Supported in all versions. required: false schema: type: integer format: int32 default: 100 - name: filter[last_match_activity_on][from] in: query description: 'Optional. Returns only cases with last_match_activity_on greater or equal to this date (ISO 8601). Available from v1.1 onwards; ignored when Accept is v1.0. ' required: false schema: type: string example: '2021-01-01T00:00:00Z' - name: filter[last_match_activity_on][to] in: query description: 'Optional. Returns only cases with last_match_activity_on less or equal to this date (ISO 8601). Available from v1.1 onwards; ignored when Accept is v1.0. ' required: false schema: type: string example: '2021-01-01T00:00:00Z' - name: filter[correlated] in: query description: 'Optional. Filters cases by whether they are correlated to any association (true, false, or any). Available from v1.1 onwards; ignored when Accept is v1.0. ' required: false schema: type: string enum: - 'true' - 'false' - any responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseListCase' example: data: - attributes: options: search_type: PRECISE filter_content_category: - PEP has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 0 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 0 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 0 has_exclusions: false deceased: score: 0 has_exclusions: false case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: last: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 first: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 meta: count: 1 offset: last: '0' first: '0' total_count: 1 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/ResponseListCaseV11' example: data: - attributes: options: search_type: PRECISE filter_content_category: - PEP filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 0 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 0 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 0 has_exclusions: false deceased: score: 0 has_exclusions: false case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 last_match_activity_on: '2025-01-15T12:00:00' type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: last: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 first: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 meta: count: 1 offset: last: '0' first: '0' total_count: 1 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/ResponseListCaseV12' example: data: - attributes: options: search_type: PRECISE filter_content_category: - PEP filter_content_category_status: {} filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 0 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 0 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 0 has_exclusions: false deceased: score: 0 has_exclusions: false case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 last_match_activity_on: '2025-01-15T12:00:00' type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: last: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 first: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 meta: count: 1 offset: last: '0' first: '0' total_count: 1 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/ResponseListCaseV13' example: data: - attributes: options: search_type: PRECISE filter_content_category: - PEP filter_content_category_status: {} filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 0 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 0 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 0 has_exclusions: false deceased: score: 0 has_exclusions: false case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: true timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 last_match_activity_on: '2025-01-15T12:00:00' alert_reason: - PERSON type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: last: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 first: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 meta: count: 1 offset: last: '0' first: '0' total_count: 1 application/json: schema: $ref: '#/components/schemas/ResponseListCase' example: data: - attributes: options: search_type: PRECISE filter_content_category: - PEP has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 0 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 0 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 0 has_exclusions: false deceased: score: 0 has_exclusions: false case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: last: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 first: https://api.example.com/risk-entity-screening-cases?page[limit]=5&page[offset]=0 meta: count: 1 offset: last: '0' first: '0' total_count: 1 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] post: tags: - Risk and Compliance Screening and Monitoring summary: Adds a new case description: Creates a new risk-entity-screening case for the account. operationId: postCaseUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/RequestCase' example: data: attributes: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - PEP - SOC - AME search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/RequestCaseV11' example: data: attributes: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/RequestCaseV12' example: data: attributes: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/RequestCaseV13' example: data: attributes: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/json: schema: $ref: '#/components/schemas/RequestCase' example: data: attributes: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - PEP - SOC - AME search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true type: risk-entity-screening-cases required: true responses: '201': description: Created content: application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseCase' example: data: attributes: options: search_type: PRECISE filter_content_category: - PEP - SOC - AME has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/ResponseCaseV11' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/ResponseCaseV12' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/ResponseCaseV13' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponseCase' example: data: attributes: options: search_type: PRECISE filter_content_category: - PEP - SOC - AME has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] /risk-entity-screening-cases/bulk-associations: post: tags: - Risk and Compliance Screening and Monitoring summary: Adds a new case with all associations. Returns a new transaction id of this operation description: Creates a new case with all associations in one request. Returns a transaction ID for async status. operationId: saveCaseUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestShortcutCase' example: data: attributes: case_info: case_name: Example Case owner_id: owner-001 external_id: ext-001 options: filter_content_category: - SOR - WL - SL - OEL - OOL - PEP - SIP - RCA - SOC - AME has_to_match_low_quality_alias: false search_type: BROAD score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: false associations: - record_type: PERSON names: - name_type: PRIMARY single_string_name: John Doe identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: '1970' external_id: assoc-001 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 country: USA industry_sector: ITECH external_id: assoc-002 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_1.1+json: schema: $ref: '#/components/schemas/RequestShortcutCaseV11' example: data: attributes: case_info: case_name: Example Case owner_id: owner-001 external_id: ext-001 options: filter_content_category: - SOR - WL - SL - OEL - OOL - PEP - SIP - RCA - SOC - AME filter_source: - DJRC has_to_match_low_quality_alias: false search_type: BROAD score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: false industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: false associations: - record_type: PERSON names: - name_type: PRIMARY single_string_name: John Doe identification_details: type: 1023 value: Passport123 gender: MALE country: USA year_of_birth: '1970' external_id: assoc-001 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp identification_details: type: 1006 value: Duns123 country: USA industry_sector: ITECH external_id: assoc-002 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_1.2+json: schema: $ref: '#/components/schemas/RequestShortcutCaseV12' example: data: attributes: case_info: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: true filter_source: - DJRC has_to_match_low_quality_alias: false search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true associations: - record_type: PERSON names: - name_type: PRIMARY single_string_name: John Doe gender: MALE country: USA external_id: assoc-001 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_2.0+json: schema: $ref: '#/components/schemas/RequestShortcutCaseV20' example: data: attributes: case_info: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 8 has_exclusions: true country: score: 2 has_exclusions: true associations: - record_type: PERSON names: - name_type: PRIMARY single_string_name: John Doe gender: MALE country: USA external_id: assoc-001 year_of_birth: specific_year: 1985 - record_type: PERSON names: - name_type: PRIMARY single_string_name: Jane Smith gender: FEMALE country: GBR external_id: assoc-002 year_of_birth: from: 1980 to: 1990 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_2.1+json: schema: $ref: '#/components/schemas/RequestShortcutCaseV21' example: data: attributes: case_info: case_name: Example Case external_id: ext-001 owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: true filter_source: - DJRC has_to_match_low_quality_alias: false search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true associations: - record_type: PERSON names: - name_type: PRIMARY single_string_name: John Doe gender: MALE country: USA external_id: assoc-001 alert_reason: - LOCATION - STATE_OWNED_COMPANY type: bulk-associations application/json: schema: $ref: '#/components/schemas/RequestShortcutCase' required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/bulk-associations: post: tags: - Risk and Compliance Screening and Monitoring summary: Creates a batch of associations and correlates them with the given case. Returns a new transaction ID of this operation description: Creates a batch of associations and correlates them to the case. Returns a transaction ID for async status. operationId: saveAssociationBatchUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestShortcutAssociations' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Jane middle_name: Elizabeth last_name: Johnson - name_type: AKA first_name: Jane last_name: Smith gender: FEMALE year_of_birth: 1985 country: GBR external_id: add-001 is_deceased: false identification_details: type: 1023 value: GB1234567 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Global Trading LLC country: USA industry_sector: IFIN external_id: add-002 identification_details: type: 1006 value: '123456789' type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_2.0+json: schema: $ref: '#/components/schemas/RequestShortcutAssociationsV20' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Maria last_name: Garcia - name_type: MAIDEN first_name: Maria last_name: Rodriguez gender: FEMALE year_of_birth: specific_year: 1990 country: ESP external_id: esp-001 is_deceased: false - record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Unknown year_of_birth: from: 1968 to: 1972 country: USA external_id: range-001 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: European Holdings GmbH country: DEU industry_sector: IFIN external_id: eu-001 type: bulk-associations application/json: schema: $ref: '#/components/schemas/RequestShortcutAssociations' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Jane middle_name: Elizabeth last_name: Johnson - name_type: AKA first_name: Jane last_name: Smith gender: FEMALE year_of_birth: 1985 country: GBR external_id: add-001 is_deceased: false identification_details: type: 1023 value: GB1234567 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Global Trading LLC country: USA industry_sector: IFIN external_id: add-002 identification_details: type: 1006 value: '123456789' type: bulk-associations required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: BULK status: PROCESSING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 1 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/bulk-associations/{transaction_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Gets status of a bulk transaction description: Returns the status and details of a bulk-associations transaction by case and transaction ID. operationId: getBulkTransactionUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string - name: transaction_id in: path description: Id of the transaction. required: true schema: type: string - name: details in: query description: Flag to control details fetching required: false schema: type: boolean default: false responses: '200': description: OK content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcutTransaction' example: data: attributes: status: COMPLETED operation: CORRELATE case_id: 00000000-0000-0000-0000-000000000001 invalid_associations: 0 pending_associations: 0 processing_associations: 0 valid_associations: 2 id: 00000000-0000-0000-0000-000000000002 links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/bulk-associations/00000000-0000-0000-0000-000000000002 type: transactions application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcutTransaction' example: data: attributes: status: COMPLETED operation: CORRELATE case_id: 00000000-0000-0000-0000-000000000001 invalid_associations: 0 pending_associations: 0 processing_associations: 0 valid_associations: 2 id: 00000000-0000-0000-0000-000000000002 links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/bulk-associations/00000000-0000-0000-0000-000000000002 type: transactions application/json: schema: $ref: '#/components/schemas/ResponseShortcutTransaction' example: data: attributes: status: COMPLETED operation: CORRELATE case_id: 00000000-0000-0000-0000-000000000001 invalid_associations: 0 pending_associations: 0 processing_associations: 0 valid_associations: 2 id: 00000000-0000-0000-0000-000000000002 links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/bulk-associations/00000000-0000-0000-0000-000000000002 type: transactions '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Retrieves a case by ID description: Returns a single risk-entity-screening case by its ID. operationId: getCaseByIdUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseCase' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/ResponseCaseV11' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/ResponseCaseV12' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: {} filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/ResponseCaseV13' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: {} filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponseCase' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Example Case external_id: ext-001 owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 1 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] delete: tags: - Risk and Compliance Screening and Monitoring summary: Removes a case description: Deletes a case by ID. Returns 204 No Content on success. operationId: deleteCaseUsingDELETE parameters: - name: case_id in: path description: Id of the case. required: true schema: type: string responses: '204': description: No Content content: {} '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] patch: tags: - Risk and Compliance Screening and Monitoring summary: Modifies a case description: 'Partially updates a case. Response type depends on Accept header (case resource or transaction for async). Note: The filter_content_category structure must match the case''s original version. v1.0 uses simple string array, v1.1+ uses nested objects. ' operationId: patchCaseUsingPATCH parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/RequestPatchCase' example: data: attributes: case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 options: filter_content_category: - SOR - WL - SL - OEL - OOL - PEP - SIP - RCA - SOC - AME has_to_match_low_quality_alias: false search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/RequestPatchCaseV11' example: data: attributes: case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/RequestPatchCaseV12' example: data: attributes: case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/RequestPatchCaseV13' example: data: attributes: case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS - AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true country: score: 2 has_exclusions: true type: risk-entity-screening-cases application/json: schema: $ref: '#/components/schemas/RequestPatchCase' example: data: attributes: case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 options: filter_content_category: - SOR - WL - SL - OEL - OOL - PEP - SIP - RCA - SOC - AME has_to_match_low_quality_alias: false search_type: PRECISE score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true type: risk-entity-screening-cases required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: PATCH_CASE status: COMPLETED case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponsePatchCase' example: data: attributes: options: search_type: PRECISE filter_content_category: - SOC - OOL - WL - RCA - SOR - OEL - SL - AME - PEP - SIP has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: score: 5 has_exclusions: false identification_details: score: 0 has_exclusions: false country: score: 2 has_exclusions: true deceased: {} case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 is_case_valid: true case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 2 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.1+json: schema: $ref: '#/components/schemas/ResponsePatchCaseV11' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_source: - DJRC score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 2 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.2+json: schema: $ref: '#/components/schemas/ResponsePatchCaseV12' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:00:00' revision: 2 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.3+json: schema: $ref: '#/components/schemas/ResponsePatchCaseV13' example: data: attributes: options: search_type: PRECISE filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC has_to_match_low_quality_alias: false score_threshold: 0.6 is_indexed: true has_screen_priority: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 0 has_exclusions: true industry_sector: {} identification_details: {} country: score: 2 has_exclusions: true deceased: {} case_name: Updated Case Name external_id: ext-001-updated owner_id: owner-001 is_case_valid: true has_alerts: false timestamp: '2025-01-15T12:00:00' updated_in: '2025-01-15T12:30:00' revision: 2 type: risk-entity-screening-cases links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: PATCH_CASE status: COMPLETED case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 0 invalid_associations: 0 pending_associations: 0 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/matches: get: tags: - Risk and Compliance Screening and Monitoring summary: Finds persons/entities matching search criteria given case ID description: Returns matches (persons/entities) for a case with optional filters and pagination. operationId: getMatchesByCaseIdUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string - name: page[offset] in: query description: 'Zero-based index of the first item to return. Optional; when omitted the server uses 0 (first page). Response meta.offset.first reflects the applied offset. ' required: false schema: type: integer format: int32 default: 0 - name: page[limit] in: query description: 'Maximum number of matches to return per page. Optional; when omitted the server uses 100. Response meta.count reflects the number of items returned. ' required: false schema: type: integer format: int32 default: 100 - name: associationId in: query description: Optional filter by association Id required: false schema: type: string - name: filter[association.id] in: query description: Optional filter by association Id only for version 3.0 or greater required: false schema: type: string - name: hasAlerts in: query description: Optional filter by matches with alerts only for version 1.0 required: false schema: $ref: '#/components/schemas/HasAlertsAndMatchValidity' - name: filter[has_alerts] in: query description: Optional filter by matches with alerts only for version 1.1 or greater required: false schema: $ref: '#/components/schemas/HasAlertsAndMatchValidity' - name: filter[is_match_valid] in: query description: Optional filter by matches with validity only for version 1.1 or greater required: false schema: $ref: '#/components/schemas/HasAlertsAndMatchValidity' - name: filter[match_update_date][timestamp_from] in: query description: Optional filter by match update from date only for version 3.0 or greater required: false schema: type: string format: date-time - name: filter[match_update_date][timestamp_to] in: query description: Optional filter by match update to date only for version 3.0 or greater required: false schema: type: string format: date-time - name: filter[alert_update.date][timestamp_from] in: query description: Optional filter by match alert update from date only for version 3.0 or greater required: false schema: type: string format: date-time - name: filter[alert_update.date][timestamp_to] in: query description: Optional filter by match alert update to date only for version 3.0 or greater required: false schema: type: string format: date-time - name: sort in: query description: 'Optional sort parameter only for version 3.0 or greater. Format: +field (ascending) or -field (descending). Valid fields: percentage_match, match_update_date, match_creation_date, subscription_name. In URL query strings, use %2B for ascending (e.g. sort=%2Bpercentage_match); a literal + may be interpreted as a space.' required: false schema: type: string example: -percentage_match enum: - +percentage_match - -percentage_match - +match_update_date - -match_update_date - +match_creation_date - -match_creation_date - +subscription_name - -subscription_name responses: '200': description: OK content: application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/ResponseListAssociationMatches' example: data: - attributes: matches: - peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true has_alerts: true match_count: 1 external_id: ext-001 type: matches links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: first: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.matches.v_1.1+json: schema: $ref: '#/components/schemas/ResponseListAssociationMatches' example: data: - attributes: matches: - peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true has_alerts: true match_count: 1 external_id: ext-001 type: matches links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: first: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.matches.v_1.2+json: schema: $ref: '#/components/schemas/ResponseListAssociationMatchesV12' example: data: - attributes: matches: - peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true filter_source: DJRC has_alerts: true match_count: 1 external_id: ext-001 type: matches links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: first: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.matches.v_2.0+json: schema: $ref: '#/components/schemas/ResponseListAssociationMatchesV20' example: data: - attributes: matches: - peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true filter_source: DJRC has_alerts: true match_count: 1 external_id: ext-001 type: matches links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001 id: 00000000-0000-0000-0000-000000000001 links: first: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.matches.v_3.0+json: schema: $ref: '#/components/schemas/ResponseListMatchesV30' example: data: - attributes: peid: '000000' variation: structural: false linguistic: false non_linguistic: false title: Example match source: DJRC match_name: John Michael Doe match_type: PRECISE match_profile_revision: '1' percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA match_origin: ASSOCIATION is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_update_date: '2025-01-15T12:00:00Z' primary_name: prefix: Mr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true matched_name_type: PRIMARY pep_inactive_since: day: 1 month: 1 year: 2020 creation_date: '2025-01-15T12:00:00Z' alert_update: date: '2025-01-15T12:00:00Z' type: matches relationships: screening_case: links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 data: id: 00000000-0000-0000-0000-000000000001 type: risk-entity-screening-cases profile: links: related: https://api.example.com/riskentities/profiles/000000 data: id: '000000' type: profiles association: links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 data: id: 00000000-0000-0000-0000-000000000002 type: risk-entity-screening-associations meta: has_alerts: true id: example-match-id-00000000000000000000000000000001 links: first: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=100 next: https://api.example.com/risk-entity-screening-cases/{case_id}/matches?page[limit]=100&page[offset]=100 meta: count: 100 offset: first: '0' last: '100' next: '100' total_count: 145 application/json: schema: $ref: '#/components/schemas/ResponseListAssociationMatches' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/matches/{match_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Retrieves a single match by ID operationId: getMatchByIdUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string - name: match_id in: path description: Id of the Match. required: true schema: type: string responses: '200': description: OK content: application/vnd.dowjones.dna.matches.v_3.0+json: schema: $ref: '#/components/schemas/ResponseMatchV30' example: data: attributes: peid: '000000' variation: structural: false linguistic: false non_linguistic: false title: Example match source: DJRC match_name: John Michael Doe match_type: PRECISE match_profile_revision: '1' percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA match_origin: ASSOCIATION is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_update_date: '2025-01-15T12:00:00Z' primary_name: prefix: Mr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true matched_name_type: PRIMARY pep_inactive_since: day: 1 month: 1 year: 2020 creation_date: '2025-01-15T12:00:00Z' alert_update: date: '2025-01-15T12:00:00Z' type: matches relationships: screening_case: links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 data: id: 00000000-0000-0000-0000-000000000001 type: risk-entity-screening-cases profile: links: related: https://api.example.com/riskentities/profiles/000000 data: id: '000000' type: profiles association: links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 data: id: 00000000-0000-0000-0000-000000000002 type: risk-entity-screening-associations meta: has_alerts: false id: example-match-id-00000000000000000000000000000001 application/json: schema: $ref: '#/components/schemas/ResponseMatch' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found security: - bearerAuth: [] patch: tags: - Risk and Compliance Screening and Monitoring summary: Adds a feedback to a Match description: 'Updates feedback or status for a single match by case and match ID. When using versioned media types, the Accept and Content-Type headers must use the same version; otherwise the API returns 406 Not Acceptable. ' operationId: patchMatchUsingPATCH parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string - name: match_id in: path description: Id of the Match. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match application/vnd.dowjones.dna.matches.v_1.1+json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match application/vnd.dowjones.dna.matches.v_1.2+json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match application/vnd.dowjones.dna.matches.v_2.0+json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match application/vnd.dowjones.dna.matches.v_3.0+json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match application/json: schema: $ref: '#/components/schemas/RequestPatchMatch' example: data: attributes: current_state: CLEARED comment: Not the profile we are looking for risk_rating: 1 type: match required: true responses: '200': description: OK content: application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/ResponseMatch' example: data: attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true type: matches id: '00000000000000000000000000000001' application/vnd.dowjones.dna.matches.v_1.1+json: schema: $ref: '#/components/schemas/ResponseMatch' example: data: attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true type: matches id: '00000000000000000000000000000001' application/vnd.dowjones.dna.matches.v_1.2+json: schema: $ref: '#/components/schemas/ResponseMatchV12' example: data: attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true filter_source: DJRC type: matches id: '00000000000000000000000000000001' application/vnd.dowjones.dna.matches.v_2.0+json: schema: $ref: '#/components/schemas/ResponseMatchV20' example: data: attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 1 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' state: OPEN birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true filter_source: DJRC type: matches id: '00000000000000000000000000000001' application/vnd.dowjones.dna.matches.v_3.0+json: schema: $ref: '#/components/schemas/ResponseMatchV30' example: data: attributes: peid: '000000' variation: structural: false linguistic: false non_linguistic: false title: Example match source: DJRC match_name: John Michael Doe match_type: PRECISE match_profile_revision: '1' percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA match_origin: ASSOCIATION is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Not the profile we are looking for state: CLEARED risk_rating: 1 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_update_date: '2025-01-15T12:00:00Z' primary_name: prefix: Mr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true matched_name_type: PRIMARY pep_inactive_since: day: 1 month: 1 year: 2020 creation_date: '2025-01-15T12:00:00Z' alert_update: date: '2025-01-15T12:00:00Z' type: matches relationships: screening_case: links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 data: id: 00000000-0000-0000-0000-000000000001 type: risk-entity-screening-cases profile: links: related: https://api.example.com/riskentities/profiles/000000 data: id: '000000' type: profiles association: links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 data: id: 00000000-0000-0000-0000-000000000002 type: risk-entity-screening-associations meta: has_alerts: false id: example-match-id-00000000000000000000000000000001 application/json: schema: $ref: '#/components/schemas/ResponseMatch' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/bulk-match-update: patch: tags: - Risk and Compliance Screening and Monitoring summary: Adds a feedback to a list of matches description: Bulk update of feedback or status for multiple matches in a case. operationId: patchMatchesUsingPATCH parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.bulk-match-update.v_1.2+json: schema: $ref: '#/components/schemas/BulkMatchUpdateRequest' example: data: - id: '00000000000000000000000000000001' type: matches attributes: current_state: CONFIRMED comment: Confirmed match risk_rating: 1 application/vnd.dowjones.dna.bulk-match-update.v_2.0+json: schema: $ref: '#/components/schemas/BulkMatchUpdateRequest' example: data: - id: '00000000000000000000000000000001' type: matches attributes: current_state: CONFIRMED comment: Confirmed match risk_rating: 1 application/vnd.dowjones.dna.bulk-match-update.v_3.0+json: schema: $ref: '#/components/schemas/BulkMatchUpdateRequest' example: data: - id: '00000000000000000000000000000001' type: matches attributes: current_state: CONFIRMED comment: Confirmed match risk_rating: 1 application/json: schema: $ref: '#/components/schemas/BulkMatchUpdateRequest' example: data: - id: '00000000000000000000000000000001' type: matches attributes: current_state: CONFIRMED comment: Confirmed match risk_rating: 1 required: true responses: '200': description: OK content: application/vnd.dowjones.dna.bulk-match-update.v_1.2+json: schema: $ref: '#/components/schemas/ResponseBulkMatch' example: data: - attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Confirmed match state: CONFIRMED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' comment: Initial review state: OPEN risk_rating: 0 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true filter_source: DJRC type: matches id: '00000000000000000000000000000001' meta: count: 1 application/vnd.dowjones.dna.bulk-match-update.v_2.0+json: schema: $ref: '#/components/schemas/ResponseBulkMatchV20' example: data: - attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Inactive primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Confirmed match state: CONFIRMED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' comment: Initial review state: OPEN risk_rating: 0 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true filter_source: DJRC type: matches id: '00000000000000000000000000000001' meta: count: 1 application/vnd.dowjones.dna.bulk-match-update.v_3.0+json: schema: $ref: '#/components/schemas/ResponseBulkMatchV30' example: data: - attributes: peid: '000000' variation: structural: false linguistic: false non_linguistic: false title: Example match source: DJRC match_name: John Michael Doe match_type: PRECISE match_profile_revision: '1' percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - icon_hint: PEP status: Not available primary_country: USA match_origin: ASSOCIATION is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Confirmed match state: CONFIRMED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' comment: Initial review state: OPEN risk_rating: 0 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_update_date: '2025-01-15T12:00:00Z' primary_name: prefix: Mr name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: true is_match_valid: true pep_inactive_since: day: 1 month: 1 year: 2020 creation_date: '2025-01-15T12:00:00Z' alert_update: date: '2025-01-15T12:00:00Z' type: matches relationships: screening_case: links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001 data: id: 00000000-0000-0000-0000-000000000001 type: risk-entity-screening-cases profile: links: related: https://api.example.com/riskentities/profiles/000000 data: id: '000000' type: profiles association: links: related: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 data: id: 00000000-0000-0000-0000-000000000002 type: risk-entity-screening-associations meta: has_alerts: true id: '00000000000000000000000000000001' meta: count: 1 application/json: schema: $ref: '#/components/schemas/ResponseBulkMatch' example: data: - attributes: peid: '000000' type: RELATIONSHIP variation: structural: false linguistic: false non_linguistic: false title: Example match match_id: '00000000000000000000000000000001' match_name: John Michael Doe match_type: PRECISE percentage_match: 0.95 subscription_name: Doe boosting_events: [] icon_hints: - PEP primary_country: USA is_score_boosted: false current_state: timestamp: '2025-01-15T12:00:00Z' comment: Confirmed match state: CONFIRMED risk_rating: 1 previous_state: - timestamp: '2025-01-14T12:00:00Z' comment: Initial review state: OPEN risk_rating: 0 birthdates: - day: 1 month: 1 year: 1980 gender: MALE is_deceased: false match_date: '2025-01-15T12:00:00' primary_name: name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe has_alerts: false is_match_valid: true filter_source: DJRC type: matches id: '00000000000000000000000000000001' meta: count: 1 '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonErrorExt' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/risk-entity-screening-associations: get: tags: - Risk and Compliance Screening and Monitoring summary: Finds the associations of a given case ID description: Returns paginated associations linked to the given case. operationId: findAssociationsUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: page[offset] in: query description: Page offset. required: false schema: type: integer format: int32 default: 0 - name: page[limit] in: query description: Page limit. required: false schema: type: integer format: int32 default: 100 - name: case_id in: path description: Id of the case. required: true schema: type: string responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseListCaseAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} year_of_birth: 1970 external_id: ext-001 has_alerts: true is_deceased: false type: risk-entity-screening-associations links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json: schema: $ref: '#/components/schemas/ResponseListCaseAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} year_of_birth: 1970 external_id: ext-001 has_alerts: true is_deceased: false type: risk-entity-screening-associations links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json: schema: $ref: '#/components/schemas/ResponseListCaseAssociationV20' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} year_of_birth: specific_year: 1970 external_id: ext-001 has_alerts: true is_deceased: false type: risk-entity-screening-associations links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 application/json: schema: $ref: '#/components/schemas/ResponseListCaseAssociation' example: data: - attributes: gender: MALE country: USA record_type: PERSON names: - name_type: PRIMARY first_name: John middle_name: Michael last_name: Doe identification_details: {} year_of_birth: 1970 external_id: ext-001 has_alerts: true is_deceased: false type: risk-entity-screening-associations links: related: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 self: https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/risk-entity-screening-associations?page[limit]=100&page[offset]=0 meta: count: 1 offset: first: '0' last: '0' total_count: 1 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] post: tags: - Risk and Compliance Screening and Monitoring summary: Adds one or more associations to a given case ID description: Correlates existing associations to a case. Request body lists association IDs. Returns transaction for async status. operationId: addAssociationUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/RelationshipRequest' example: data: - id: 00000000-0000-0000-0000-000000000001 - id: 00000000-0000-0000-0000-000000000002 - id: 00000000-0000-0000-0000-000000000003 application/json: schema: $ref: '#/components/schemas/RelationshipRequest' example: data: - id: 00000000-0000-0000-0000-000000000001 - id: 00000000-0000-0000-0000-000000000002 - id: 00000000-0000-0000-0000-000000000003 required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: CORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 3 invalid_associations: 0 pending_associations: 3 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/risk-entity-screening-associations/delete: post: tags: - Risk and Compliance Screening and Monitoring summary: Decorrelate a bulk of associations from a case description: Removes multiple associations from a case in one request. Request body lists association IDs. Returns transaction for async status. operationId: decorrelateBulkAssociationsUsingPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/RelationshipRequest' example: data: - id: 00000000-0000-0000-0000-000000000001 - id: 00000000-0000-0000-0000-000000000002 application/json: schema: $ref: '#/components/schemas/RelationshipRequest' example: data: - id: 00000000-0000-0000-0000-000000000001 - id: 00000000-0000-0000-0000-000000000002 required: true responses: '202': description: Accepted content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATIONS status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 2 invalid_associations: 0 pending_associations: 2 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000003 id: 00000000-0000-0000-0000-000000000003 '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/risk-entity-screening-associations/{association_id}: delete: tags: - Risk and Compliance Screening and Monitoring summary: Decorrelate a single association from a case description: Removes one association from a case. Returns 202 Accepted with transaction for async status. operationId: decorrelateCaseAssociationUsingDELETE parameters: - name: case_id in: path description: Id of the case. required: true schema: type: string - name: association_id in: path description: Id of the association. required: true schema: type: string responses: '202': description: Accepted content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 application/vnd.dowjones.dna.matches.v_1.0+json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 application/json: schema: $ref: '#/components/schemas/ResponseShortcut' example: data: attributes: operation: DECORRELATE_ASSOCIATION status: PENDING case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 1 invalid_associations: 0 pending_associations: 1 processing_associations: 0 type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000004 id: 00000000-0000-0000-0000-000000000004 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/transactions/{transaction_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Gets status of a transaction by Case and Id description: Returns the status and details of a transaction scoped to a case. operationId: getTransactionByCaseUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string - name: transaction_id in: path description: Id of the transaction. required: true schema: type: string - name: details in: query description: Flag to control details fetching required: false schema: type: boolean default: false - name: page[offset] in: query description: Page offset. required: true schema: type: integer format: int32 default: 0 - name: page[limit] in: query description: Page limit. required: true schema: type: integer format: int32 default: 100 responses: '200': description: OK content: application/vnd.dowjones.dna.transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseDataTransaction' example: data: attributes: operation: CREATE_CASE status: COMPLETED case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 10 invalid_associations: 2 pending_associations: 0 processing_associations: 0 created_at: '2025-01-15T12:00:00Z' updated_at: '2025-01-15T12:01:30Z' details: - association_id: 00000000-0000-0000-0000-000000000001 status: COMPLETED match_count: 3 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000002 status: COMPLETED match_count: 1 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000003 status: FAILED match_count: 0 message: Invalid name format - association_id: 00000000-0000-0000-0000-000000000004 status: FAILED match_count: 0 message: 'Missing required field: record_type' type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true meta: count: 4 offset: first: '0' last: '3' total_count: 4 application/vnd.dowjones.dna.risk-entity-screening-cases.v_1.0+json: schema: $ref: '#/components/schemas/ResponseDataTransaction' example: data: attributes: operation: CREATE_CASE status: COMPLETED case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 10 invalid_associations: 2 pending_associations: 0 processing_associations: 0 created_at: '2025-01-15T12:00:00Z' updated_at: '2025-01-15T12:01:30Z' details: - association_id: 00000000-0000-0000-0000-000000000001 status: COMPLETED match_count: 3 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000002 status: COMPLETED match_count: 1 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000003 status: FAILED match_count: 0 message: Invalid name format - association_id: 00000000-0000-0000-0000-000000000004 status: FAILED match_count: 0 message: 'Missing required field: record_type' type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true meta: count: 4 offset: first: '0' last: '3' total_count: 4 application/json: schema: $ref: '#/components/schemas/ResponseDataTransaction' example: data: attributes: operation: CREATE_CASE status: COMPLETED case_id: 00000000-0000-0000-0000-000000000001 valid_associations: 10 invalid_associations: 2 pending_associations: 0 processing_associations: 0 created_at: '2025-01-15T12:00:00Z' updated_at: '2025-01-15T12:01:30Z' details: - association_id: 00000000-0000-0000-0000-000000000001 status: COMPLETED match_count: 3 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000002 status: COMPLETED match_count: 1 message: Successfully screened - association_id: 00000000-0000-0000-0000-000000000003 status: FAILED match_count: 0 message: Invalid name format - association_id: 00000000-0000-0000-0000-000000000004 status: FAILED match_count: 0 message: 'Missing required field: record_type' type: transactions links: self: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002 id: 00000000-0000-0000-0000-000000000002 links: first: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true last: https://api.example.com/risk-entity-screening-cases/00000000-0000-0000-0000-000000000001/transactions/00000000-0000-0000-0000-000000000002?page[limit]=100&page[offset]=0&details=true meta: count: 4 offset: first: '0' last: '3' total_count: 4 '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-transactions/{transaction_id}: get: tags: - Risk and Compliance Screening and Monitoring summary: Gets status of a transaction description: Returns the status and details of a risk-entity-screening transaction by ID. operationId: getTransactionUsingGET parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: transaction_id in: path description: Id of the transaction. required: true schema: type: string - name: details in: query description: Flag to control details fetching required: false schema: type: boolean default: false responses: '200': description: OK content: application/vnd.dowjones.dna.risk-entity-screening-transactions.v_1.0+json: schema: $ref: '#/components/schemas/ResponseDataExtendedTransaction' application/json: schema: $ref: '#/components/schemas/ResponseDataExtendedTransaction' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] /risk-entity-screening-cases/validate-bulk-associations: post: tags: - Risk and Compliance Screening and Monitoring summary: Validates that a Shortcut Case payload does not have validation errors. Returns a valid "status" and information about any errors that might be in the request description: Validates a shortcut case payload without persisting. Returns validation status and any errors. operationId: validateCaseShortcutPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestShortcutCase' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team options: filter_content_category: - PEP - SOC - AME search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 8 has_exclusions: true country: score: 6 has_exclusions: false associations: - record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe gender: MALE year_of_birth: 1970 country: USA external_id: cust-001 - record_type: PERSON names: - name_type: PRIMARY first_name: '' last_name: Smith gender: INVALID_VALUE year_of_birth: 2050 country: ZZZ external_id: cust-002 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Acme Corp country: USA industry_sector: ITECH external_id: corp-001 - record_type: INVALID_TYPE names: - name_type: PRIMARY single_string_name: Bad Entity external_id: bad-001 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_1.2+json: schema: $ref: '#/components/schemas/RequestShortcutCaseV12' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team options: filter_content_category: - WL: - SL: - US-OFAC - OOL: - US-BIS AME: - '33' filter_content_category_status: is_san_active: true is_ool_active: false filter_source: - DJRC search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 8 has_exclusions: true country: score: 6 has_exclusions: false associations: - record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe gender: MALE year_of_birth: 1970 country: USA external_id: cust-001 - record_type: ENTITY names: - name_type: PRIMARY country: USA external_id: corp-001 type: bulk-associations application/json: schema: $ref: '#/components/schemas/RequestShortcutCase' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team options: filter_content_category: - PEP - SOC - AME search_type: PRECISE score_threshold: 0.6 is_indexed: true score_preferences: gender: score: 4 has_exclusions: false year_of_birth: score: 8 has_exclusions: true country: score: 6 has_exclusions: false associations: - record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Doe gender: MALE year_of_birth: 1970 country: USA external_id: cust-001 type: bulk-associations required: true responses: '200': description: OK content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ValidateCaseShortcutResponse' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team status: INVALID errors: - field: case_info.associations[1].names[0].first_name message: First name cannot be empty value: '' - field: case_info.associations[1].gender message: Invalid gender value. Must be MALE or FEMALE value: INVALID_VALUE - field: case_info.associations[1].year_of_birth message: Year of birth cannot be in the future value: 2050 - field: case_info.associations[1].country message: Invalid ISO country code value: ZZZ - field: case_info.associations[3].record_type message: Invalid record type. Must be PERSON, ENTITY, or UNKNOWN value: INVALID_TYPE associations: - external_id: cust-001 status: VALID errors: [] - external_id: cust-002 status: INVALID errors: - field: names[0].first_name message: First name cannot be empty value: '' - field: gender message: Invalid gender value. Must be MALE or FEMALE value: INVALID_VALUE - field: year_of_birth message: Year of birth cannot be in the future value: 2050 - field: country message: Invalid ISO country code value: ZZZ - external_id: corp-001 status: VALID errors: [] - external_id: bad-001 status: INVALID errors: - field: record_type message: Invalid record type. Must be PERSON, ENTITY, or UNKNOWN value: INVALID_TYPE summary: total_associations: 4 valid_associations: 2 invalid_associations: 2 validation_status: INVALID type: validation-results application/vnd.dowjones.dna.bulk-associations.v_1.2+json: schema: $ref: '#/components/schemas/ValidateCaseShortcutResponse' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team status: INVALID errors: - field: case_info.associations[1].names[0].single_string_name message: Entity name is required for ENTITY record type associations: - external_id: cust-001 status: VALID errors: [] - external_id: corp-001 status: INVALID errors: - field: names[0].single_string_name message: Entity name is required for ENTITY record type summary: total_associations: 2 valid_associations: 1 invalid_associations: 1 validation_status: INVALID type: validation-results application/json: schema: $ref: '#/components/schemas/ValidateCaseShortcutResponse' example: data: attributes: case_info: case_name: Q4 2024 Customer Screening external_id: batch-2024-q4-001 owner_id: compliance-team status: VALID errors: [] associations: - external_id: cust-001 status: VALID errors: [] summary: total_associations: 1 valid_associations: 1 invalid_associations: 0 validation_status: VALID type: validation-results '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/JsonError' '401': description: Unauthorized content: {} '403': description: Forbidden content: {} security: - bearerAuth: [] /risk-entity-screening-cases/{case_id}/validate-bulk-associations: post: tags: - Risk and Compliance Screening and Monitoring summary: Validates that a Shortcut Associations payload does not have validation errors. Returns a valid "status" and information about any errors that might be in the request description: Validates a shortcut associations payload for a case without persisting. Returns validation status and any errors. operationId: validateShortcutAssociationsPOST parameters: - name: Accept-Encoding in: header description: Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to "gzip" and the payload exceeds the threshold of 8MB required: false schema: type: string - name: Content-Encoding in: header description: Which encoding the request body is being sent. The API supports gzip encoding for request body. required: false schema: type: string - name: case_id in: path description: Id of the case. required: true schema: type: string requestBody: description: request content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/RequestShortcutAssociations' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Jane middle_name: Elizabeth last_name: Johnson - name_type: AKA first_name: Jane last_name: Smith gender: FEMALE year_of_birth: 1985 country: GBR external_id: add-001 identification_details: type: 1023 value: GB1234567 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Global Trading LLC - name_type: AKA single_string_name: GT LLC country: USA industry_sector: IFIN external_id: add-002 identification_details: type: 1006 value: '123456789' - record_type: PERSON names: - name_type: PRIMARY first_name: '' last_name: InvalidPerson gender: UNKNOWN year_of_birth: 2030 country: INVALID external_id: add-003 - record_type: ENTITY names: - name_type: PRIMARY country: CHN external_id: add-004 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_1.1+json: schema: $ref: '#/components/schemas/RequestShortcutAssociationsV11' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Robert last_name: Anderson gender: MALE year_of_birth: 1975 country: USA is_deceased: false identification_details: type: 1001 value: SSN-123-45-6789 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: Tech Innovations Inc country: USA industry_sector: ITECH external_id: tech-001 - record_type: UNKNOWN names: - name_type: PRIMARY single_string_name: Unknown Entity Type external_id: unk-001 type: bulk-associations application/vnd.dowjones.dna.bulk-associations.v_2.0+json: schema: $ref: '#/components/schemas/RequestShortcutAssociationsV20' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: Maria last_name: Garcia - name_type: MAIDEN first_name: Maria last_name: Rodriguez gender: FEMALE year_of_birth: specific_year: 1990 country: ESP external_id: esp-001 - record_type: PERSON names: - name_type: PRIMARY first_name: John last_name: Unknown year_of_birth: from: 1968 to: 1972 country: USA external_id: range-001 - record_type: ENTITY names: - name_type: PRIMARY single_string_name: European Holdings GmbH - name_type: NATIVE_SCRIPT single_string_name: ヨーロッパホールディングス country: DEU industry_sector: IFIN external_id: eu-001 type: bulk-associations application/json: schema: $ref: '#/components/schemas/RequestShortcutAssociations' example: data: attributes: associations: - record_type: PERSON names: - name_type: PRIMARY first_name: David last_name: Williams gender: MALE year_of_birth: 1980 country: AUS external_id: aus-001 type: bulk-associations required: true responses: '200': description: OK content: application/vnd.dowjones.dna.bulk-associations.v_1.0+json: schema: $ref: '#/components/schemas/ValidateAssociationsShortcutResponse' example: data: attributes: associations: - external_id: add-001 status: VALID errors: [] - external_id: add-002 status: VALID errors: [] - external_id: add-003 status: INVALID errors: - field: names[0].first_name message: First name cannot be empty for PERSON record type value: '' - field: gender message: Invalid gender value. Must be MALE or FEMALE value: UNKNOWN - field: year_of_birth message: Year of birth cannot be in the future value: 2030 - field: country message: Invalid ISO country code value: INVALID - external_id: add-004 status: INVALID errors: - field: names[0].single_string_name message: Entity name is required for ENTITY record type summary: total_associations: 4 valid_associations: 2 invalid_associations: 2 validation_status: INVALID case_id: 550e8400-e29b-41d4-a716-446655440000 type: validation-results application/vnd.dowjones.dna.bulk-associations.v_1.1+json: schema: $ref: '#/components/schemas/ValidateAssociationsShortcutResponse' example: data: attributes: associations: - status: VALID errors: [] - external_id: tech-001 status: VALID errors: [] - external_id: unk-001 status: VALID errors: [] summary: total_associations: 3 valid_associations: 3 invalid_associations: 0 validation_status: VALID case_id: 550e8400-e29b-41d4-a716-446655440000 type: validation-results application/vnd.dowjones.dna.bulk-associations.v_2.0+json: schema: $ref: '#/components/schemas/ValidateAssociationsShortcutResponse' example: data: attributes: associations: - external_id: esp-001 status: VALID errors: [] - external_id: range-001 status: VALID errors: [] - external_id: eu-001 status: VALID errors: [] summary: total_associations: 3 valid_associations: 3 invalid_associations: 0 validation_status: VALID case_id: 550e8400-e29b-41d4-a716-446655440000 type: validation-results application/json: schema: $ref: '#/components/schemas/ValidateAssociationsShortcutResponse' example: data: attributes: associations: - external_id: aus-001 status: VALID errors: [] summary: total_associations: 1 valid_associations: 1 invalid_associations: 0 validation_status: VALID case_id: 550e8400-e29b-41d4-a716-446655440000 type: validation-results '401': description: Unauthorized content: {} '403': description: Forbidden content: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/JsonError' security: - bearerAuth: [] components: schemas: ResponseDataCaseV13: type: object properties: attributes: $ref: '#/components/schemas/CaseResponseV13' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string RequestShortcutAssociations: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutAssociations' BatchOptionsV11: required: - search_type type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: boolean example: false is_indexed: type: boolean example: false score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD RequestPatchCaseV13: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataPatchCaseV13' ResponseDataCase: type: object properties: attributes: $ref: '#/components/schemas/Case' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string PatchBatchOptions: type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' has_to_match_low_quality_alias: type: boolean example: false is_indexed: type: boolean example: false score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD Transaction: type: object properties: attributes: $ref: '#/components/schemas/TransactionData' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string RequestCaseV12: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataCaseV12' RequestShortcutCaseV20: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutCaseV20' CaseAssociations: type: object properties: associations: type: array items: $ref: '#/components/schemas/Association' case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/BatchOptions' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' RequestPatchCase: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataPatchCase' AssociationMatchesV20: type: object properties: external_id: type: string has_alerts: type: boolean match_count: type: integer matches: type: array items: $ref: '#/components/schemas/MatchV20' JsonErrorMeta: type: object properties: request_index: type: integer type: type: string id: type: string ResponseDataMatchV30: type: object properties: attributes: $ref: '#/components/schemas/MatchV30' id: type: string type: type: string relationships: $ref: '#/components/schemas/ResponseMatchRelationships' FilterContentCategoryEnum: type: string enum: - WL - SL - OEL - OOL - PEP - SIP - RCA - SOC - AME - REG - COMPFIN - ENVPROD - SOCLAB - ECR ResponseCaseV11: type: object properties: data: $ref: '#/components/schemas/ResponseDataCaseV11' ResponseCase: type: object properties: data: $ref: '#/components/schemas/ResponseDataCase' RequestAssociationV20: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataAssociationV20' ResponsePatchAssociationV20: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchAssociationV20' PatchMatch: type: object properties: comment: type: string current_state: type: string enum: - OPEN - CLEARED - PERMANENTLY_CLEARED - CONFIRMED - CONFIRMED_BLOCKED - CONFIRMED_UNDER_REVIEW - CONFIRMED_RISK_MITIGATED match_id: type: string risk_rating: type: number timestamp: type: string format: date-time ResponseDataExtendedTransaction: type: object properties: data: $ref: '#/components/schemas/ExtendedTransaction' ErrorDetails: type: object properties: title: type: string status: type: integer code: type: integer detail: type: string Identification: type: object properties: type: type: string value: type: string Match: type: object properties: birthdates: type: array items: $ref: '#/components/schemas/DateParts' boosting_events: type: array items: $ref: '#/components/schemas/BoosterEvent' current_state: $ref: '#/components/schemas/MatchFeedback' has_alerts: type: boolean icon_hints: type: array items: type: string is_match_valid: type: boolean is_score_boosted: type: boolean is_deceased: type: boolean match_date: type: string match_id: type: string match_invalid_date: type: string match_invalid_reason: type: string match_name: type: string match_type: type: string enum: - PRECISE - NEAR - BROAD peid: type: string percentage_match: type: number format: double previous_state: type: array items: $ref: '#/components/schemas/MatchFeedback' primary_country: type: string gender: type: string primary_name: $ref: '#/components/schemas/Name' subscription_name: type: string title: type: string type: type: string variation: $ref: '#/components/schemas/Variation' ResponseLinksSelf: type: object properties: self: type: string ShortcutCaseV12: type: object properties: case_info: $ref: '#/components/schemas/CaseAssociationsV12' RequestDataShortcutCase: type: object properties: attributes: $ref: '#/components/schemas/ShortcutCase' type: type: string ResponsePatchAssociation: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchAssociation' ResponseListCaseAssociationV20: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCaseAssociationV20' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' BulkMatchUpdateRequest: type: object properties: data: type: array items: $ref: '#/components/schemas/BulkMatchUpdateData' RequestCaseV11: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataCaseV11' RequestDataAssociationV20: type: object properties: attributes: $ref: '#/components/schemas/AssociationV20' type: type: string ResponseListCaseV13: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCaseV13' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' RequestPatchCaseV11: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataPatchCaseV11' FilterContentCategoryHierarchy: type: object example: WL: - SL: - '122' - OOL: - ABD AME: - '33' RequestShortcutCaseV12: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutCaseV12' ResponsePatchCaseV12: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchCaseV12' RequestDataPatchCaseV11: type: object properties: attributes: $ref: '#/components/schemas/PatchCaseV11' type: type: string RequestDataCaseV11: type: object properties: attributes: $ref: '#/components/schemas/CaseV11' type: type: string RequestDataPatchMatch: type: object properties: attributes: $ref: '#/components/schemas/PatchMatch' type: type: string RequestCase: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataCase' ResponseListAssociation: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataAssociation' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' RequestDataShortcutAssociationsV20: type: object properties: attributes: $ref: '#/components/schemas/ShortcutAssociationsV20' type: type: string ShortcutCaseV21: type: object properties: case_info: $ref: '#/components/schemas/CaseAssociationsV21' PatchBatchOptionsV11: type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: boolean example: false is_indexed: type: boolean example: false score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD ShortcutCaseV11: type: object properties: case_info: $ref: '#/components/schemas/CaseAssociationsV11' RequestDataCaseV12: type: object properties: attributes: $ref: '#/components/schemas/CaseV12' type: type: string CaseResponseV13: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean timestamp: type: string format: date-time updated_in: type: string format: date-time revision: type: integer format: int32 is_case_valid: type: boolean alert_reason: uniqueItems: true type: array example: - ENTITY - WATCHLIST items: type: string options: $ref: '#/components/schemas/BatchOptionsV13' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' FilterContentCategoryStatus: type: - object - 'null' properties: is_san_active: type: - boolean - 'null' is_sor_active: type: - boolean - 'null' is_ool_active: type: - boolean - 'null' is_oel_active: type: - boolean - 'null' is_soc_active: type: - boolean - 'null' is_pep_active: type: - boolean - 'null' is_rca_active: type: - boolean - 'null' is_meu_active: type: - boolean - 'null' MatchV20: type: object properties: birthdates: type: array items: $ref: '#/components/schemas/DateParts' boosting_events: type: array items: $ref: '#/components/schemas/BoosterEvent' current_state: $ref: '#/components/schemas/MatchFeedback' has_alerts: type: boolean icon_hints: type: array items: $ref: '#/components/schemas/IconHint' is_match_valid: type: boolean is_score_boosted: type: boolean is_deceased: type: boolean match_date: type: string match_id: type: string match_invalid_date: type: string match_invalid_reason: type: string match_name: type: string match_type: type: string enum: - PRECISE - NEAR - BROAD peid: type: string percentage_match: type: number format: double filter_source: type: string example: DJRC previous_state: type: array items: $ref: '#/components/schemas/MatchFeedback' primary_country: type: string gender: type: string primary_name: $ref: '#/components/schemas/Name' subscription_name: type: string title: type: string type: type: string variation: $ref: '#/components/schemas/Variation' ResourceDetails: type: object properties: id: type: string external_id: type: string request_index: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetails' ResponseAssociationRelationship_meta: type: object properties: external_id: type: string has_alerts: type: boolean RequestDataShortcutCaseV12: type: object properties: attributes: $ref: '#/components/schemas/ShortcutCaseV12' type: type: string PatchBatchOptionsV12: type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_content_category_status: $ref: '#/components/schemas/FilterContentCategoryStatus' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: - boolean - 'null' example: false is_indexed: type: - boolean - 'null' example: false score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD ResponseDataCaseV12: type: object properties: attributes: $ref: '#/components/schemas/CaseV12' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string ShortcutTransaction: type: object properties: status: $ref: '#/components/schemas/TransactionStatus' operation: type: string case_id: type: string invalid_associations: type: integer format: int32 pending_associations: type: integer format: int32 processing_associations: type: integer format: int32 valid_associations: type: integer format: int32 valid_association_ids: type: array items: type: string invalid_association_details: type: array items: type: string ResponseMatchV20: type: object properties: data: $ref: '#/components/schemas/ResponseDataMatchV20' Case: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean is_case_valid: type: boolean options: $ref: '#/components/schemas/BatchOptions' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' ResponseDataCaseV11: type: object properties: attributes: $ref: '#/components/schemas/CaseV11' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string RequestDataPatchCaseV13: type: object properties: attributes: $ref: '#/components/schemas/PatchCaseV13' type: type: string BoosterEvent: type: object properties: boost_value: type: number format: double field: type: string ResponseDataShortcutTransaction: type: object properties: attributes: $ref: '#/components/schemas/ShortcutTransaction' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string RequestShortcutCaseV21: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutCaseV21' BulkMatchUpdateData: type: object properties: id: type: string type: type: string attributes: $ref: '#/components/schemas/PatchMatch' RelationshipRequest: type: object properties: data: type: array items: $ref: '#/components/schemas/RelationshipData' ShortcutCaseV20: type: object properties: case_info: $ref: '#/components/schemas/CaseAssociationsV20' ScorePreference: type: object properties: has_exclusions: type: boolean score: type: integer format: int32 ResourceDetailsNoErrors: type: object properties: id: type: string external_id: type: string request_index: type: string ResponseBulkMatchV20: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataMatchV20' RequestShortcutCaseV11: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutCaseV11' ResponseDataAssociationMatchesV12: type: object properties: attributes: $ref: '#/components/schemas/AssociationMatchesV12' id: type: string links: $ref: '#/components/schemas/DataLinks' type: type: string ResponsePatchCase: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchCase' ResponseLinks: type: object properties: first: type: string last: type: string next: type: string prev: type: string ResponseDataAssociationV20: type: object properties: attributes: $ref: '#/components/schemas/AssociationV20' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string ResponseShortcutTransaction: type: object properties: data: $ref: '#/components/schemas/ResponseDataShortcutTransaction' AssociationMatches: type: object properties: external_id: type: string has_alerts: type: boolean match_count: type: integer matches: type: array items: $ref: '#/components/schemas/Match' TransactionData: type: object properties: status: $ref: '#/components/schemas/TransactionStatus' operation: type: string case_id: type: string invalid_associations: type: integer format: int32 pending_associations: type: integer format: int32 processing_associations: type: integer format: int32 valid_associations: type: integer format: int32 valid_association_ids: type: array items: type: string invalid_association_ids: type: array items: type: string invalid_association_details: type: array items: type: string RequestDataShortcutAssociationsV11: type: object properties: attributes: $ref: '#/components/schemas/ShortcutAssociationsV11' type: type: string RequestDataAssociation: type: object properties: attributes: $ref: '#/components/schemas/Association' type: type: string ResponseListCaseV11: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCaseV11' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' CaseAssociation: type: object properties: country: type: string external_id: type: string gender: type: string enum: - MALE - FEMALE identification_details: $ref: '#/components/schemas/Identification' industry_sector: type: string names: type: array items: $ref: '#/components/schemas/Name' record_type: type: string enum: - PERSON - ENTITY - UNKNOWN year_of_birth: type: integer format: int32 has_alerts: type: boolean is_deceased: type: boolean CaseV11: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean last_match_activity_on: type: string example: '2021-06-09T14:34:12.358' is_case_valid: type: boolean options: $ref: '#/components/schemas/BatchOptionsV11' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' ResponseDataShortcut: type: object properties: attributes: $ref: '#/components/schemas/Shortcut' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string ResponseRelationship: type: object properties: links: $ref: '#/components/schemas/ResponseAssociationRelationship_links' data: $ref: '#/components/schemas/RelationshipData' YearOfBirth: type: - object - 'null' properties: specific_year: type: - integer - 'null' description: Specific year of birth (mutually exclusive with from/to) format: int32 from: type: - integer - 'null' description: Start of year range (requires 'to' field) format: int32 to: type: - integer - 'null' description: End of year range (requires 'from' field) format: int32 description: Year of birth can be specified as either a specific year OR a range. Use specific_year for exact year, or from/to for a range. These fields are mutually exclusive. ResponseDataAssociation: type: object properties: attributes: $ref: '#/components/schemas/Association' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string ExtendedTransaction: type: object properties: attributes: $ref: '#/components/schemas/ExtendedTransactionData' id: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' type: type: string RequestDataShortcutCaseV20: type: object properties: attributes: $ref: '#/components/schemas/ShortcutCaseV20' type: type: string ShortcutAssociationsV20: type: object properties: associations: type: array items: $ref: '#/components/schemas/AssociationV20' DataLinks: type: object properties: related: type: string self: type: string CaseAssociationsV21: type: object properties: associations: type: array items: $ref: '#/components/schemas/Association' case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/BatchOptionsV13' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' alert_reason: type: array example: - ENTITY - WATCHLIST items: type: string IconHint: type: object properties: icon_hint: type: string example: OOL-PERSON status: type: string example: Active ResponseCaseV13: type: object properties: data: $ref: '#/components/schemas/ResponseDataCaseV13' PatchCase: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/PatchBatchOptions' score_preferences: $ref: '#/components/schemas/ScorePreferences' ResponseAssociationRelationship_links: type: object properties: related: type: string ResponseDataPatchCaseV13: type: object properties: attributes: $ref: '#/components/schemas/CaseResponseV13' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' RequestDataCaseV13: type: object properties: attributes: $ref: '#/components/schemas/CaseV13' type: type: string RequestDataAssociationV11: type: object properties: attributes: $ref: '#/components/schemas/AssociationV11' type: type: string ResponseMatch: type: object properties: data: $ref: '#/components/schemas/ResponseDataMatch' AssociationV11: type: object properties: country: type: - string - 'null' external_id: type: - string - 'null' gender: type: - string - 'null' enum: - MALE - FEMALE identification_details: $ref: '#/components/schemas/IdentificationV11' industry_sector: type: - string - 'null' names: type: array items: $ref: '#/components/schemas/Name' record_type: type: string enum: - PERSON - ENTITY - UNKNOWN year_of_birth: type: - integer - 'null' format: int32 is_deceased: type: - boolean - 'null' ResponseDataPatchAssociationV20: type: object properties: attributes: $ref: '#/components/schemas/CaseAssociationV20' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' ResponseDataMatchV12: type: object properties: attributes: $ref: '#/components/schemas/MatchV12' id: type: string type: type: string RequestShortcutAssociationsV20: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutAssociationsV20' ResponseCaseV12: type: object properties: data: $ref: '#/components/schemas/ResponseDataCaseV12' ResponseListCaseAssociation: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCaseAssociation' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' ResponseListAssociationMatchesV20: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataAssociationMatchesV20' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' MatchV30: type: object properties: birthdates: type: array items: $ref: '#/components/schemas/DateParts' boosting_events: type: array items: $ref: '#/components/schemas/BoosterEvent' current_state: $ref: '#/components/schemas/MatchFeedbackV30' has_alerts: type: boolean icon_hints: type: array items: $ref: '#/components/schemas/IconHint' is_match_valid: type: boolean is_score_boosted: type: boolean is_deceased: type: boolean match_date: type: string format: date-time match_update_date: type: string format: date-time alert_update: $ref: '#/components/schemas/AlertUpdate' match_invalid_date: type: string format: date-time match_invalid_reason: type: string match_name: type: string match_type: type: string enum: - PRECISE - NEAR - BROAD matched_name_type: type: string enum: - PRIMARY - MAIDEN - SV - ELV - AKA - LQAKA - FKA - SSN - OSN peid: type: string percentage_match: type: number format: double source: type: string example: DJRC previous_state: type: array items: $ref: '#/components/schemas/MatchFeedbackV30' primary_country: type: string gender: type: string primary_name: $ref: '#/components/schemas/Name' subscription_name: type: string title: type: string match_origin: type: string enum: - ASSOCIATION - WATCHLIST variation: $ref: '#/components/schemas/Variation' pep_inactive_since: $ref: '#/components/schemas/DateParts' rca_inactive_since: $ref: '#/components/schemas/DateParts' ResponseMatchV30: type: object properties: data: $ref: '#/components/schemas/ResponseDataMatchV30' Association: type: object properties: country: type: string external_id: type: string gender: type: string enum: - MALE - FEMALE identification_details: $ref: '#/components/schemas/Identification' industry_sector: type: string names: type: array items: $ref: '#/components/schemas/Name' record_type: type: string enum: - PERSON - ENTITY - UNKNOWN year_of_birth: type: integer format: int32 is_deceased: type: boolean CaseAssociationV20: type: object properties: country: type: string external_id: type: string gender: type: string enum: - MALE - FEMALE identification_details: $ref: '#/components/schemas/Identification' industry_sector: type: string names: type: array items: $ref: '#/components/schemas/Name' record_type: type: string enum: - PERSON - ENTITY - UNKNOWN year_of_birth: $ref: '#/components/schemas/YearOfBirth' has_alerts: type: boolean is_deceased: type: boolean RequestPatchMatch: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataPatchMatch' ResponsePatchCaseV11: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchCaseV11' ResponseDataAssociationMatchesV20: type: object properties: attributes: $ref: '#/components/schemas/AssociationMatchesV20' id: type: string links: $ref: '#/components/schemas/DataLinks' type: type: string ResponseAssociationRelationship: type: object properties: links: $ref: '#/components/schemas/ResponseAssociationRelationship_links' data: $ref: '#/components/schemas/RelationshipData' meta: $ref: '#/components/schemas/ResponseAssociationRelationship_meta' ResponsePatchCaseV13: required: - data type: object properties: data: $ref: '#/components/schemas/ResponseDataPatchCaseV13' ResponseListCaseV12: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCaseV12' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' ResponseDataMatch: type: object properties: attributes: $ref: '#/components/schemas/Match' id: type: string type: type: string ResponseListMatchesV30: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataMatchV30' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' Variation: type: object properties: linguistic: type: boolean non_linguistic: type: boolean structural: type: boolean RequestDataPatchCaseV12: type: object properties: attributes: $ref: '#/components/schemas/PatchCaseV12' type: type: string RequestShortcutAssociationsV11: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutAssociationsV11' AssociationMatchesV12: type: object properties: external_id: type: string has_alerts: type: boolean match_count: type: integer matches: type: array items: $ref: '#/components/schemas/MatchV12' ResponseShortcut: type: object properties: data: $ref: '#/components/schemas/ResponseDataShortcut' RequestCaseV13: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataCaseV13' ValidateCaseShortcutResponse: type: object properties: data: $ref: '#/components/schemas/ValidateCaseShortcutData' ResponseListCase: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataCase' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' MatchFeedbackV30: type: object properties: comment: type: string id: type: string risk_rating: type: number state: type: string enum: - OPEN - CLEARED - PERMANENTLY_CLEARED - CONFIRMED - CONFIRMED_BLOCKED - CONFIRMED_UNDER_REVIEW - CONFIRMED_RISK_MITIGATED timestamp: type: string format: date-time ResponseDataAssociationMatches: type: object properties: attributes: $ref: '#/components/schemas/AssociationMatches' id: type: string links: $ref: '#/components/schemas/DataLinks' type: type: string CaseV13: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean last_match_activity_on: type: string example: '2021-06-09T14:34:12.358' is_case_valid: type: boolean options: $ref: '#/components/schemas/BatchOptionsV13' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' alert_reason: uniqueItems: true type: array example: - ENTITY - WATCHLIST items: type: string BatchOptionsV12: required: - search_type type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_content_category_status: $ref: '#/components/schemas/FilterContentCategoryStatus' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: - boolean - 'null' example: false is_indexed: type: - boolean - 'null' example: true score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD RelationshipData: type: object properties: id: type: string type: type: string ResponseDataPatchCaseV12: type: object properties: attributes: $ref: '#/components/schemas/CaseV12' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' RequestDataCase: type: object properties: attributes: $ref: '#/components/schemas/Case' type: type: string MatchFeedback: type: object properties: comment: type: string id: type: string risk_rating: type: number state: type: string enum: - OPEN - CLEARED - PERMANENTLY_CLEARED - CONFIRMED - CONFIRMED_BLOCKED - CONFIRMED_UNDER_REVIEW - CONFIRMED_RISK_MITIGATED RequestPatchCaseV12: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataPatchCaseV12' ResponseListAssociationV20: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataAssociationV20' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' TransactionStatus: type: string enum: - PENDING - PROCESSING - COMPLETED RequestDataShortcutCaseV21: type: object properties: attributes: $ref: '#/components/schemas/ShortcutCaseV21' type: type: string MatchV12: type: object properties: birthdates: type: array items: $ref: '#/components/schemas/DateParts' boosting_events: type: array items: $ref: '#/components/schemas/BoosterEvent' current_state: $ref: '#/components/schemas/MatchFeedback' has_alerts: type: boolean icon_hints: type: array items: type: string is_match_valid: type: boolean is_score_boosted: type: boolean is_deceased: type: boolean match_date: type: string match_id: type: string match_invalid_date: type: string match_invalid_reason: type: string match_name: type: string match_type: type: string enum: - PRECISE - NEAR - BROAD peid: type: string percentage_match: type: number format: double filter_source: type: string example: DJRC previous_state: type: array items: $ref: '#/components/schemas/MatchFeedback' primary_country: type: string gender: type: string primary_name: $ref: '#/components/schemas/Name' subscription_name: type: string title: type: string type: type: string variation: $ref: '#/components/schemas/Variation' ResponseDataMatchV20: type: object properties: attributes: $ref: '#/components/schemas/MatchV20' id: type: string type: type: string ResponseDataCaseAssociationV20: type: object properties: attributes: $ref: '#/components/schemas/CaseAssociationV20' id: type: string links: $ref: '#/components/schemas/DataLinks' type: type: string ResponseDataPatchAssociation: type: object properties: attributes: $ref: '#/components/schemas/CaseAssociation' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' Shortcut: type: object properties: status: $ref: '#/components/schemas/TransactionStatus' operation: type: string case_id: type: string invalid_associations: type: integer format: int32 pending_associations: type: integer format: int32 processing_associations: type: integer format: int32 valid_associations: type: integer format: int32 ResponseAssociationV20: type: object properties: data: $ref: '#/components/schemas/ResponseDataAssociationV20' ShortcutCase: type: object properties: case_info: $ref: '#/components/schemas/CaseAssociations' RequestShortcutCase: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataShortcutCase' JsonError: type: object properties: code: type: integer format: int32 detail: type: string status: type: integer format: int32 title: type: string RequestAssociationV11: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataAssociationV11' IdentificationV11: type: - object - 'null' properties: type: type: - string - 'null' value: type: - string - 'null' ResponseMeta: type: object properties: count: type: integer format: int32 offset: $ref: '#/components/schemas/ResponseLinks' total_count: type: integer format: int32 BatchOptionsV13: required: - search_type type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_content_category_status: $ref: '#/components/schemas/FilterContentCategoryStatusV13' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: - boolean - 'null' example: false is_indexed: type: - boolean - 'null' example: true has_screen_priority: type: - boolean - 'null' example: true score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD CaseAssociationsV12: type: object properties: associations: type: array items: $ref: '#/components/schemas/Association' case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/BatchOptionsV13' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' HasAlertsAndMatchValidity: type: string enum: - any - 'true' - 'false' CaseV12: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean last_match_activity_on: type: string example: '2021-06-09T14:34:12.358' is_case_valid: type: boolean options: $ref: '#/components/schemas/BatchOptionsV12' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' PatchBatchOptionsV13: type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' filter_content_category_status: $ref: '#/components/schemas/FilterContentCategoryStatusV13' filter_source: type: array items: type: string example: DJRC has_to_match_low_quality_alias: type: - boolean - 'null' example: false is_indexed: type: - boolean - 'null' example: false has_screen_priority: type: - boolean - 'null' example: true score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD RequestAssociation: required: - data type: object properties: data: $ref: '#/components/schemas/RequestDataAssociation' ShortcutAssociationsV11: type: object properties: associations: type: array items: $ref: '#/components/schemas/AssociationV11' ResponseMatchV12: type: object properties: data: $ref: '#/components/schemas/ResponseDataMatchV12' ResponseDataTransaction: type: object properties: data: $ref: '#/components/schemas/Transaction' PatchCaseV13: type: object properties: case_name: type: - string - 'null' external_id: type: - string - 'null' alert_reason: uniqueItems: true type: array example: - ENTITY - WATCHLIST items: type: string options: $ref: '#/components/schemas/PatchBatchOptionsV13' score_preferences: $ref: '#/components/schemas/ScorePreferences' ResourceDetailsNoId: type: object properties: external_id: type: string request_index: type: string errors: type: array items: $ref: '#/components/schemas/ErrorDetails' ValidationStatus: type: string enum: - INVALID - OK JsonErrorExt: type: object properties: code: type: integer format: int32 detail: type: string status: type: integer format: int32 title: type: string meta: $ref: '#/components/schemas/JsonErrorMeta' PatchCaseV12: type: object properties: case_name: type: - string - 'null' external_id: type: - string - 'null' options: $ref: '#/components/schemas/PatchBatchOptionsV12' score_preferences: $ref: '#/components/schemas/ScorePreferences' ResponseBulkMatchV30: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataMatchV30' ResponseBulkMatch: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataMatch' ResponseAssociation: type: object properties: data: $ref: '#/components/schemas/ResponseDataAssociation' ResponseDataPatchCaseV11: type: object properties: attributes: $ref: '#/components/schemas/CaseV11' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' ShortcutAssociations: type: object properties: associations: type: array items: $ref: '#/components/schemas/Association' PatchCaseV11: type: object properties: case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/PatchBatchOptionsV11' score_preferences: $ref: '#/components/schemas/ScorePreferences' RequestDataShortcutAssociations: type: object properties: attributes: $ref: '#/components/schemas/ShortcutAssociations' type: type: string ResponseMatchRelationships: type: object properties: screening_case: $ref: '#/components/schemas/ResponseRelationship' association: $ref: '#/components/schemas/ResponseAssociationRelationship' profile: $ref: '#/components/schemas/ResponseRelationship' custom_source_profile: $ref: '#/components/schemas/ResponseRelationship' RequestDataPatchCase: type: object properties: attributes: $ref: '#/components/schemas/PatchCase' type: type: string ResponseDataCaseAssociation: type: object properties: attributes: $ref: '#/components/schemas/CaseAssociation' id: type: string links: $ref: '#/components/schemas/DataLinks' type: type: string ExtendedTransactionData: type: object properties: status: $ref: '#/components/schemas/TransactionStatus' operation: type: string case_id: type: string case_external_id: type: string valid_associations_count: type: integer format: int32 invalid_associations_count: type: integer format: int32 pending_associations_count: type: integer format: int32 processing_associations_count: type: integer format: int32 valid_associations: type: array items: $ref: '#/components/schemas/ResourceDetailsNoErrors' invalid_associations: type: array items: $ref: '#/components/schemas/ResourceDetails' CaseAssociationsV20: type: object properties: associations: type: array items: $ref: '#/components/schemas/AssociationV20' case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/BatchOptionsV13' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' ResponseListAssociationMatches: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataAssociationMatches' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' ValidateAssociationsShortcutData: type: object properties: type: type: string status: $ref: '#/components/schemas/ValidationStatus' invalid_association_details: type: array items: $ref: '#/components/schemas/ResourceDetailsNoId' FilterContentCategoryStatusV13: type: - object - 'null' properties: is_san_active: type: - boolean - 'null' is_sor_active: type: - boolean - 'null' is_ool_active: type: - boolean - 'null' is_oel_active: type: - boolean - 'null' is_soc_active: type: - boolean - 'null' is_pep_active: type: - boolean - 'null' is_rca_active: type: - boolean - 'null' is_meu_active: type: - boolean - 'null' is_tae_active: type: - boolean - 'null' DateParts: type: object properties: day: type: integer format: int32 month: type: integer format: int32 year: type: integer format: int32 CaseAssociationsV11: type: object properties: associations: type: array items: $ref: '#/components/schemas/Association' case_name: type: string external_id: type: string has_alerts: type: boolean options: $ref: '#/components/schemas/BatchOptionsV11' owner_id: type: string score_preferences: $ref: '#/components/schemas/ScorePreferences' ValidateAssociationsShortcutResponse: type: object properties: data: $ref: '#/components/schemas/ValidateAssociationsShortcutData' RequestDataShortcutCaseV11: type: object properties: attributes: $ref: '#/components/schemas/ShortcutCaseV11' type: type: string AssociationV20: type: object properties: country: type: - string - 'null' external_id: type: - string - 'null' gender: type: - string - 'null' enum: - MALE - FEMALE identification_details: $ref: '#/components/schemas/IdentificationV11' industry_sector: type: - string - 'null' names: type: array items: $ref: '#/components/schemas/Name' record_type: type: string enum: - PERSON - ENTITY - UNKNOWN year_of_birth: $ref: '#/components/schemas/YearOfBirth' is_deceased: type: - boolean - 'null' BatchOptions: required: - filter_content_category - search_type type: object properties: filter_content_category: type: array items: oneOf: - $ref: '#/components/schemas/FilterContentCategoryHierarchy' - $ref: '#/components/schemas/FilterContentCategoryEnum' has_to_match_low_quality_alias: type: boolean example: false is_indexed: type: boolean example: false score_threshold: type: number format: double search_type: type: string enum: - PRECISE - NEAR - BROAD ResponseListAssociationMatchesV12: type: object properties: data: type: array items: $ref: '#/components/schemas/ResponseDataAssociationMatchesV12' links: $ref: '#/components/schemas/ResponseLinks' meta: $ref: '#/components/schemas/ResponseMeta' ResponseDataPatchCase: type: object properties: attributes: $ref: '#/components/schemas/Case' id: type: string type: type: string links: $ref: '#/components/schemas/ResponseLinksSelf' Name: type: object properties: entity_name: type: string first_name: type: string last_name: type: string middle_name: type: string name_type: type: string enum: - PRIMARY - MAIDEN - SV - ELV - AKA - LQAKA - FKA - SSN - OSN prefix: type: string suffix: type: string single_string_name: type: string AlertUpdate: type: object properties: date: type: string description: Date and time of the alert update in ISO 8601 format format: date-time example: '2025-07-10T12:15:44.73Z' changed_sections: type: array description: List of sections that were changed in the alert update example: - RELATIONSHIP - ENTITY items: type: string enum: - BASIC - ENTITY - PERSON - RELATIONSHIP - IMAGE_DETAILS - STATE_OWNED_COMPANY - ADVERSE_MEDIA - LOCATION - HIGH_RISK_FACTORS - MILITARY_ASSOCIATED_ENTITY - TRADE_RESTRICTED_ASSOCIATED_ENTITY - WATCHLIST - WATCHLIST_PEP - WATCHLIST_SCO - WATCHLIST_LIST_REF - WATCHLIST_LIST_REF_SAN - WATCHLIST_LIST_REF_OEL - WATCHLIST_LIST_REF_OOL - OTHER_CHANGES - PROFILE_CREATED - PROFILE_DELETED description: Represents the result of the last alert update of the match ScorePreferences: type: object properties: country: $ref: '#/components/schemas/ScorePreference' gender: $ref: '#/components/schemas/ScorePreference' identification_details: $ref: '#/components/schemas/ScorePreference' industry_sector: $ref: '#/components/schemas/ScorePreference' year_of_birth: $ref: '#/components/schemas/ScorePreference' deceased: $ref: '#/components/schemas/ScorePreference' ValidateCaseShortcutData: type: object properties: type: type: string status: $ref: '#/components/schemas/ValidationStatus' invalid_case_details: $ref: '#/components/schemas/ResourceDetailsNoId' invalid_association_details: type: array items: $ref: '#/components/schemas/ResourceDetailsNoId' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT