openapi: 3.0.1 info: title: Evelyn - Name Sanctions Screening (NSS) (2.0.0) description: >- Name Screening AlertRequest Review for Sanctions and Politically Exposed Persons or Name Screening AlertRequest Review is a skill of the Digital Worker Evelyn and a critical component of "Know Your Customer" (KYC) and Anti-Money Laundering (AML) guidelines. The automation is designed to identify sanctioned individuals, entities, securities, or all relevant names during on-boarding and throughout the customer relationship's lifecycle that may pose a risk to the institution. contact: name: WorkFusion Inc url: https://www.workfusion.com/digital-workers/evelyn version: '1.0' servers: - url: https://example-workfusion.workfusion.io description: Production server variables: {} security: - oauth: [] paths: /input-connector-rest/start-record-raw/{signalId}: post: tags: - Evelyn NSS summary: Submit full alertRequest for screening operationId: start-record-raw parameters: - name: signalId in: path description: signal ID for the BP where the record is to be sent required: true schema: type: string requestBody: description: >- AlertRequest to be screened. All fields besides input_id, input_full_name are optional. content: application/json: schema: $ref: '#/components/schemas/AlertRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertProcessingResponse' /input-connector-rest/start-record-raw/{signalId-firco}: post: tags: - Evelyn NSS summary: Trigger screening for Firco Trust operationId: start-record-raw-firco parameters: - name: signalId-firco in: path description: signal ID for the BP where the record is to be sent required: true schema: type: string requestBody: description: Trigger Firco Trust Screening content: application/json: schema: $ref: '#/components/schemas/FircoRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertProcessingResponse' /input-connector-rest/check-record-status/{requestId}: get: tags: - Evelyn NSS summary: Check record processing status description: >- Checks a record status based on the specified `requestId`. Returns the record processing status. operationId: check-record-status parameters: - name: requestId in: path description: Request UUID to track a request required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/AlertProcessingResponse' /input-connector-rest/get-record-result/{requestId}: get: tags: - Evelyn NSS summary: Get screening decision description: >- Gets a screening decision based on the specified `requestId`. Returns the record results. operationId: get-record-result parameters: - name: requestId in: path description: Request UUID to track a request required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AlertResponse' /input-connector-rest/get-record-result/{firco-requestId}: get: tags: - Evelyn NSS summary: Get screening decision description: >- Gets a screening decision based on the specified `requestId`. Returns the record results. operationId: firco-get-record-result parameters: - name: firco-requestId in: path description: Request UUID to track a request required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FircoResponse' components: schemas: AlertProcessingResponse: type: object properties: requestId: type: string description: Unique identifier assigned to the request. status: type: string description: Processing status of the request. enum: - COMPLETED - IN_PROGRESS - FAILED - NOT_AUTHORIZED - NOT_FOUND - INVALID_REQUEST statusDetails: type: string description: >- Status details: error details for FAILED status. etc. Empty for COMPLETED status. example: Record Processing Started Address: type: object properties: type: type: string description: Type of address like Citizenship, Residence of ..., free text country: type: string state: type: string city: type: string street: type: string address: type: string description: Full address description: WLE address information AlertRequest: type: object properties: input_id: type: string description: Customer identification number input_full_name: type: string description: Customer Full Name input_first_name: type: string description: Customer First Name input_middle_name: type: string description: Customer Middle Name input_last_name: type: string description: Customer Last Name input_record_type: type: string description: Customer entity type enum: - INDIVIDUAL - ORGANIZATION - SECURITIES input_gender: type: string description: Customer gender in case Individual screening enum: - MALE - FEMALE - OTHER input_address: type: array description: Customer Address information items: $ref: '#/components/schemas/Address' input_date: type: array description: Customer Date information items: $ref: '#/components/schemas/Date' input_aliases: type: array description: Customer alias names items: type: string description: Customer alias names identifiers: type: object additionalProperties: type: string description: Customer identifiers description: Customer identifiers additional_data: type: object additionalProperties: type: string description: Customer Additional Data description: Customer Additional Data category: type: string description: Customer category hits: type: array description: Hits associated with this AlertRequest items: $ref: '#/components/schemas/HitRequest' configuration: type: object additionalProperties: type: string description: Configuration parameters to be sent to Digital Worker description: Configuration parameters to be sent to Digital Worker client_id: type: string description: Unique identifier for each client input_gold_resolution: type: string description: Gold resolution for the alert. add_to_ongoing_monitor: type: boolean description: Add to ongoing monitor Date: type: object properties: type: type: string description: Type of date like DOB..., free text year: type: string description: Year YYYY format month: type: string description: Month MM format day: type: string description: Day DD format description: WLE date information HitRequest: type: object properties: hit_id: type: string description: HitRequest identification number hit_matched_name: type: string description: WLE Matched Name hit_first_name: type: string description: WLE First Name hit_middle_name: type: string description: WLE Middle Name hit_last_name: type: string description: WLE Last Name hit_record_type: type: string description: WLE Record Type enum: - INDIVIDUAL - ORGANIZATION - SECURITIES - LOCATION hit_gender: type: string description: WLE Gender if Individual enum: - MALE - FEMALE - OTHER hit_address: type: array description: WLE address information items: $ref: '#/components/schemas/Address' hit_date: type: array description: WLE date information items: $ref: '#/components/schemas/Date' hit_aliases: type: array description: WLE alias names items: type: string description: WLE alias names identifiers: type: object additionalProperties: type: string description: WLE identifiers description: WLE identifiers additional_data: type: object additionalProperties: type: string description: WLE Additional Data description: WLE Additional Data category: type: string description: WLE category hit_gold_resolution: type: string description: Gold resolution for the hit. description: Hits associated with this AlertRequest FircoRequest: type: object properties: firco_trust_unit: type: array items: type: string firco_trust_b_unit: type: string AlertResponse: type: object properties: input_id: type: string client_id: type: string description: Unique identifier for each client alert_resolution: type: string description: >- Decision on full alert. Possible values: No hits - where no hits where found, Cleared Alert - all hits for this alert have disposition as False Positive, Needs further review - at least one hit has disposition as Need more information alert_explanation: type: string description: Human readable explanation for a decision hits: type: array items: $ref: '#/components/schemas/HitResponse' html_report_link: type: string description: Link to HTML report qc_report_link: type: string description: Link to QC report auto_qc: type: boolean description: Indicates if the alert was selected for automatic quality control HitResponse: type: object properties: hit_id: type: string hit_resolution: type: string description: >- Model decision for input and hit pair. Possible values: 'False Positive' or 'Need more information' hit_explanation: type: string description: Human readable explanation for a decision hit_score: type: string description: Decision score for input and hit pair FircoResponse: type: object properties: report_link: type: array items: type: string securitySchemes: bearer: type: http description: >- Bearer API token to authorize requests. This scheme may be useful for testing, when bearer token has been already generated and available to use. scheme: bearer bearerFormat: JWT oauth: type: oauth2 description: >- This API uses OAuth 2 with password grant flow. This is default and recommended authentication mechanism. flows: password: tokenUrl: >- https://example-keycloak.workfusion.io/auth/realms/WorkfusionRealm/protocol/openid-connect/token scopes: openid: ''