openapi: 3.2.0
info:
title: Fenergo Receptor API
version: '1.0'
description: 'Operations tagged Receptor across 3 of this provider''s published API definitions: fenergo-creditscreeningreceptor-v1-0-openapi.json, fenergo-externaldatareceptor-v1-0-openapi.json, fenergo-screeningreceptor-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /creditscreeningreceptor
- url: /externaldatareceptor
- url: /screeningreceptor
tags:
- name: Receptor
paths:
/api/receptor/callback:
post:
tags:
- Receptor
summary: Callback
description: 'This method will handle adapters responses.
Processes Adapter Responses'
operationId: Callback
parameters:
- name: X-TENANT-ID
in: header
description: The UiD of the tenant representing organization
required: true
schema:
type: string
example: b11f8be3-f29b-4959-8964-956d4af7c468
requestBody:
description: Adapter response
content:
application/json:
schema:
$ref: '#/components/schemas/AdapterResponseDto'
text/json:
schema:
$ref: '#/components/schemas/AdapterResponseDto'
application/*+json:
schema:
$ref: '#/components/schemas/AdapterResponseDto'
responses:
'202':
description: Success. Data Accepted
'400':
description: Bad request. The request has missing/invalid values
content:
text/plain:
schema:
$ref: '#/components/schemas/ProblemDetails'
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal server error
'401':
description: User is not authorized to perform this request
content:
application/json:
example:
message: Unauthorized
'403':
description: Access to resource is forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: 'Access denied. Following permissions are required: Permission1, Permission2'
type: Forbidden
errorCode: Error Code
'410':
description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
content:
application/json:
schema:
$ref: '#/components/schemas/StringServiceResponse'
example:
data: null
messages:
- message: This endpoint is obsolete and was terminated on yyyy-MM-dd
type: Error
errorCode: OBSOLETE_ENDPOINT
servers:
- url: /creditscreeningreceptor
/receptor/callback:
post:
tags:
- Receptor
summary: Callback
description: 'This method will handle adapters responses.
Processes Adapter Responses'
operationId: postReceptorCallback
parameters:
- name: Compression-Algorithm
in: header
description: Compression Algorithm e.g. gzip
schema:
type: string
- name: X-TENANT-ID
in: header
description: The UiD of the tenant representing organization
required: true
schema:
type: string
example: b11f8be3-f29b-4959-8964-956d4af7c468
- name: X-PROVIDER-ID
in: header
description: The ID of the provider
schema:
type: string
example: ProviderId
- name: X-ENCRYPTION-IV
in: header
description: The encryption IV key, base64 encoded
schema:
type: string
example: HgyUHIO81m0FcZfPS1lnUw==
- name: X-AUTHENTICATION-MAC
in: header
description: The authentication MAC key, base64 encoded
schema:
type: string
example: frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE=
requestBody:
description: Adapter response
content:
application/json:
schema:
$ref: '#/components/schemas/AdapterResponseDto_2'
examples:
Search operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Success
errorDetails: null
response:
results:
- id: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
entityType: Company
fullName: My Company
matchHint: Selected
matchScore: 78
data:
companyType: Some Value
Search operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Get operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Success
errorDetails: null
response:
documents: null
client:
id: '1234567'
entityType: Company
fullName: Legal Entity Name
data:
name: Name
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
Get operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Test operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Success
errorDetails: null
response:
adapterSchema:
lookups:
- name: EntityType
values:
- Private Company
- Public Company
schema:
searchRequest:
searchCriteria:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
searchResponse:
searchResultsData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
getRequest:
requestData:
fields:
- name: Id
friendlyName: Id
type: text
description: null
lookup: null
fields: null
getResponse:
clientData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesCompanyData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesIndividualData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associationsData:
fields:
- name: ChildId
friendlyName: Child Id
type: text
description: null
lookup: null
fields: null
adapterSchemaIndividual: null
Test operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Document operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Success
errorDetails: null
response:
results:
- documentId: docId1
fileLocation: sample1.pdf
status: DocumentReceived
errorDetails: null
data: null
receiveDate: null
Document operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Ubo operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Success
errorDetails: null
response:
results:
id: '1234567'
entityId: entityId
status: Aborted
fileLocation: null
purchasedDocuments: null
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
errorDetails:
source: adapter
errorCode: code
message: Ubo Discovery was aborted on demand of user.
Ubo operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringSubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringSubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringUnsubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringUnsubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringNotification operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Success
errorDetails: null
response:
entityId: EntityId
eventType: null
eventSubtype: null
data: null
OngoingMonitoringNotification operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
text/json:
schema:
$ref: '#/components/schemas/AdapterResponseDto_2'
examples:
Search operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Success
errorDetails: null
response:
results:
- id: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
entityType: Company
fullName: My Company
matchHint: Selected
matchScore: 78
data:
companyType: Some Value
Search operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Get operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Success
errorDetails: null
response:
documents: null
client:
id: '1234567'
entityType: Company
fullName: Legal Entity Name
data:
name: Name
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
Get operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Test operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Success
errorDetails: null
response:
adapterSchema:
lookups:
- name: EntityType
values:
- Private Company
- Public Company
schema:
searchRequest:
searchCriteria:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
searchResponse:
searchResultsData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
getRequest:
requestData:
fields:
- name: Id
friendlyName: Id
type: text
description: null
lookup: null
fields: null
getResponse:
clientData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesCompanyData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesIndividualData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associationsData:
fields:
- name: ChildId
friendlyName: Child Id
type: text
description: null
lookup: null
fields: null
adapterSchemaIndividual: null
Test operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Document operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Success
errorDetails: null
response:
results:
- documentId: docId1
fileLocation: sample1.pdf
status: DocumentReceived
errorDetails: null
data: null
receiveDate: null
Document operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Ubo operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Success
errorDetails: null
response:
results:
id: '1234567'
entityId: entityId
status: Aborted
fileLocation: null
purchasedDocuments: null
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
errorDetails:
source: adapter
errorCode: code
message: Ubo Discovery was aborted on demand of user.
Ubo operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringSubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringSubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringUnsubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringUnsubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringNotification operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Success
errorDetails: null
response:
entityId: EntityId
eventType: null
eventSubtype: null
data: null
OngoingMonitoringNotification operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
application/*+json:
schema:
$ref: '#/components/schemas/AdapterResponseDto_2'
examples:
Search operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Success
errorDetails: null
response:
results:
- id: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
entityType: Company
fullName: My Company
matchHint: Selected
matchScore: 78
data:
companyType: Some Value
Search operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Search
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Get operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Success
errorDetails: null
response:
documents: null
client:
id: '1234567'
entityType: Company
fullName: Legal Entity Name
data:
name: Name
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
Get operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Get
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Test operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Success
errorDetails: null
response:
adapterSchema:
lookups:
- name: EntityType
values:
- Private Company
- Public Company
schema:
searchRequest:
searchCriteria:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
searchResponse:
searchResultsData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
getRequest:
requestData:
fields:
- name: Id
friendlyName: Id
type: text
description: null
lookup: null
fields: null
getResponse:
clientData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesCompanyData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associatedEntitiesIndividualData:
fields:
- name: LegalEntityName
friendlyName: Legal Entity Name
type: text
description: null
lookup: null
fields: null
associationsData:
fields:
- name: ChildId
friendlyName: Child Id
type: text
description: null
lookup: null
fields: null
adapterSchemaIndividual: null
Test operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Document operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Success
errorDetails: null
response:
results:
- documentId: docId1
fileLocation: sample1.pdf
status: DocumentReceived
errorDetails: null
data: null
receiveDate: null
Document operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Document
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
Ubo operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Success
errorDetails: null
response:
results:
id: '1234567'
entityId: entityId
status: Aborted
fileLocation: null
purchasedDocuments: null
hierarchy:
associatedEntities:
- id: '12345678'
entityType: Individual
fullName: Legal Entity Name Related
uboType: null
isActive: null
data:
id: _dummy
associations:
- parentId: parentId
childId: childId
ownershipPercentage: 1.34
associationType: CompanyOfficial
data:
id: _dummy
errorDetails:
source: adapter
errorCode: code
message: Ubo Discovery was aborted on demand of user.
Ubo operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Ubo
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringSubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringSubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringSubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringUnsubscription operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Success
errorDetails: null
response:
subscriptionId: subscriptionId
data: null
OngoingMonitoringUnsubscription operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringUnsubscription
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
OngoingMonitoringNotification operation - Success - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Success
errorDetails: null
response:
entityId: EntityId
eventType: null
eventSubtype: null
data: null
OngoingMonitoringNotification operation - Error - Entity type 'Company':
value:
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingMonitoringNotification
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
response: null
responses:
'202':
description: Success. Data Accepted
'400':
description: Bad request. The request has missing/invalid values
content:
text/plain:
schema:
$ref: '#/components/schemas/ServiceResponse'
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'500':
description: Internal server error
x-operation-id-source: normalized
x-operation-id-original: Callback
servers:
- url: /externaldatareceptor
/receptor/getPresignedUrl:
post:
tags:
- Receptor
summary: Create presigned url for S3 upload
operationId: GetPresignedUrl
parameters:
- name: X-TENANT-ID
in: header
description: The UiD of the tenant representing organization
required: true
schema:
type: string
example: b11f8be3-f29b-4959-8964-956d4af7c468
- name: X-PROVIDER-ID
in: header
description: The ID of the provider
schema:
type: string
example: ProviderId
- name: X-ENCRYPTION-IV
in: header
description: The encryption IV key, base64 encoded
schema:
type: string
example: HgyUHIO81m0FcZfPS1lnUw==
- name: X-AUTHENTICATION-MAC
in: header
description: The authentication MAC key, base64 encoded
schema:
type: string
example: frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE=
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSignedUrlRequestDto'
example:
documentData:
- extension: pdf
- extension: .pdf
text/json:
schema:
$ref: '#/components/schemas/CreateSignedUrlRequestDto'
example:
documentData:
- extension: pdf
- extension: .pdf
application/*+json:
schema:
$ref: '#/components/schemas/CreateSignedUrlRequestDto'
example:
documentData:
- extension: pdf
- extension: .pdf
responses:
'200':
description: OK
content:
text/plain:
schema:
$ref: '#/components/schemas/CreateSignedUrlResponseDtoListServiceResponse'
application/json:
schema:
$ref: '#/components/schemas/CreateSignedUrlResponseDtoListServiceResponse'
text/json:
schema:
$ref: '#/components/schemas/CreateSignedUrlResponseDtoListServiceResponse'
'400':
description: Bad Request
content:
text/plain:
schema:
$ref: '#/components/schemas/ServiceResponse'
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
text/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
servers:
- url: /externaldatareceptor
/api/receptor:
post:
tags:
- Receptor
summary: This method handles the results from the different screening adapters
operationId: ReceiveResults
parameters:
- name: X-TENANT-ID
in: header
description: The UiD of the tenant representing organization
schema:
type: string
example: b11f8be3-f29b-4959-8964-956d4af7c468
- name: X-PROVIDER-ID
in: header
description: The ID of the provider
schema:
type: string
example: ProviderId
- name: X-ENCRYPTION-IV
in: header
description: The encryption IV key, base64 encoded
schema:
type: string
example: HgyUHIO81m0FcZfPS1lnUw==
- name: X-AUTHENTICATION-MAC
in: header
description: The authentication MAC key, base64 encoded
schema:
type: string
example: frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE=
- name: Compression-Algorithm
in: header
description: 'The compression algorithm (if any) that has been used to compress the body of the request.
Possible values: empty string (if body is not compressed), gzip
'
schema:
type: string
requestBody:
description: The response from the adapter
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectAdapterResponseDto'
examples:
Screen operation - Success - Entity type 'Individual':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: Male
dateOfBirth: 25/01/1950
dateOfBirthList: null
country: null
entityType: Individual
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: Irish
nationality: Irish
placeOfBirth: Dublin
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: Ireland
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: null
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Success
errorDetails: null
uploadId: null
Screen operation - Success - Entity type 'Company':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: null
dateOfBirth: null
dateOfBirthList: null
country: Ireland
entityType: Company
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: null
nationality: null
placeOfBirth: null
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: null
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: Ireland
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Success
errorDetails: null
uploadId: null
Screen operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
ResolveMatches operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: ResolveMatches
status: Success
errorDetails: null
uploadId: null
ResolveMatches operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: ResolveMatches
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
Test operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Success
errorDetails: null
uploadId: null
Test operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreening operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreening
status: Success
errorDetails: null
uploadId: null
OngoingScreening operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreening
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreeningUpdate operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningUpdate
status: Success
errorDetails: null
uploadId: null
OngoingScreeningUpdate operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningUpdate
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreeningGetResults operation - Success - Entity type 'Individual':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: null
legalEntityId: bb8cd902-1aa8-456e-a22d-a4fc470e8386
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: Male
dateOfBirth: 25/01/1950
dateOfBirthList: null
country: null
entityType: Individual
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: Irish
nationality: Irish
placeOfBirth: Dublin
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: Ireland
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: null
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
configurationSetId: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningGetResults
status: Success
errorDetails: null
uploadId: null
OngoingScreeningGetResults operation - Success - Entity type 'Company':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: null
legalEntityId: bb8cd902-1aa8-456e-a22d-a4fc470e8386
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: null
dateOfBirth: null
dateOfBirthList: null
country: Ireland
entityType: Company
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: null
nationality: null
placeOfBirth: null
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: null
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: Ireland
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
configurationSetId: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningGetResults
status: Success
errorDetails: null
uploadId: null
text/plain:
schema:
$ref: '#/components/schemas/ObjectAdapterResponseDto'
examples:
Screen operation - Success - Entity type 'Individual':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: Male
dateOfBirth: 25/01/1950
dateOfBirthList: null
country: null
entityType: Individual
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: Irish
nationality: Irish
placeOfBirth: Dublin
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: Ireland
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: null
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Success
errorDetails: null
uploadId: null
Screen operation - Success - Entity type 'Company':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: null
dateOfBirth: null
dateOfBirthList: null
country: Ireland
entityType: Company
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: null
nationality: null
placeOfBirth: null
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: null
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: Ireland
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Success
errorDetails: null
uploadId: null
Screen operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Screen
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
ResolveMatches operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: ResolveMatches
status: Success
errorDetails: null
uploadId: null
ResolveMatches operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: ResolveMatches
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
Test operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Success
errorDetails: null
uploadId: null
Test operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: Test
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreening operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreening
status: Success
errorDetails: null
uploadId: null
OngoingScreening operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreening
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreeningUpdate operation - Success:
value:
response: {}
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningUpdate
status: Success
errorDetails: null
uploadId: null
OngoingScreeningUpdate operation - Error:
value:
response: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningUpdate
status: Error
errorDetails:
source: Adapter
errorCode: ''
message: The error details
uploadId: null
OngoingScreeningGetResults operation - Success - Entity type 'Individual':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: null
legalEntityId: bb8cd902-1aa8-456e-a22d-a4fc470e8386
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: Male
dateOfBirth: 25/01/1950
dateOfBirthList: null
country: null
entityType: Individual
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: Irish
nationality: Irish
placeOfBirth: Dublin
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: Ireland
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: null
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
configurationSetId: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningGetResults
status: Success
errorDetails: null
uploadId: null
OngoingScreeningGetResults operation - Success - Entity type 'Company':
value:
response:
batchExternalIds:
- source: MyProviderId
name: FieldInProvider
value: '1234'
entities:
- entityId: null
legalEntityId: bb8cd902-1aa8-456e-a22d-a4fc470e8386
externalIds:
- source: MyProviderId
entityAliasId: PrimaryName
name: FieldInProvider
value: '1234'
matchesData:
- externalId: '1234'
externalIds:
- entityAliasId: PrimaryName
value: '1234'
providerId: MyProviderId
entityAliasIds:
- PrimaryName
name: Test Entity
aliases: null
aliasesList:
- value: TE
type: Acronym
gender: null
dateOfBirth: null
dateOfBirthList: null
country: Ireland
entityType: Company
matchScore: 100
providerSourceName: MyProviderName
providerSourceUrl: https://myprovider.com/match/{matchId}
providerSourceUrls: null
addresses:
- addressLine1: Address Line 1
addressLine2: Address Line 2
city: City
postalCode: '28793'
country: Country
countryISO2: null
countryISO3: null
stateProvince: State or Province
type: Main address
category: null
citizenship: null
nationality: null
placeOfBirth: null
citizenshipList: null
nationalityList: null
placeOfBirthList: null
countryOfResidence: null
additionalInfo:
- title: Last Updated
content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
- title: Entity URL
content:
- URL1
- URL2
categories:
- Pep
- Sanctions
sources:
- URL1
- URL2
registeredCountry: Ireland
ids:
Id1: '158192327'
Id2: '1465465'
idsList: null
associations:
- externalId: e_tr_wco_1231231
category: Enforcements,AdverseMedia:CORPORATE
fullName: Test Entity
relationship: Affiliated entity
relationshipGroup: null
ownershipPercentage: null
status: null
reason: null
comments: null
subsidiaryFields: null
richTextAdditionalDetails: Some rich text details
categoryDetails: null
configurationSetId: null
id: fd23f474-eff9-425f-a776-78e2176b36e4
tenant: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId: MyProviderId
type: OngoingScreeningGetResults
status: Success
errorDetails: null
uploadId: null
responses:
'202':
description: Success. Results processed successfully
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'500':
description: Internal server error
servers:
- url: /screeningreceptor
components:
schemas:
AdapterResponseDto:
type: object
properties:
creditScreeningEnquiryId:
type:
- string
- 'null'
tenant:
type:
- string
- 'null'
providerId:
type:
- string
- 'null'
requestType:
type:
- string
- 'null'
status:
type:
- string
- 'null'
completedOn:
type:
- string
- 'null'
format: date-time
errorDetails:
type:
- string
- 'null'
errorCode:
type:
- string
- 'null'
response:
type:
- object
- 'null'
additionalProperties: {}
additionalProperties: false
ProblemDetails:
type: object
properties:
type:
type:
- string
- 'null'
title:
type:
- string
- 'null'
status:
type:
- integer
- 'null'
format: int32
detail:
type:
- string
- 'null'
instance:
type:
- string
- 'null'
additionalProperties: {}
ServiceResponseMessage:
type: object
properties:
message:
type:
- string
- 'null'
type:
type:
- string
- 'null'
errorCode:
type:
- string
- 'null'
additionalProperties: false
ObjectServiceResponse:
type: object
properties:
data: {}
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
additionalProperties: false
StringServiceResponse:
type: object
properties:
data:
type:
- string
- 'null'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
additionalProperties: false
GetRequestSchemaDto:
type: object
properties:
requestData:
$ref: '#/components/schemas/SchemaEntryDto'
additionalProperties: false
description: Schema for the "get" request.
GetResponseDto:
type: object
properties:
client:
$ref: '#/components/schemas/ObjectClientDto'
hierarchy:
$ref: '#/components/schemas/ObjectObjectHierarchyDto'
documents:
$ref: '#/components/schemas/ObjectDocumentsDto'
additionalProperties: false
SchemaEntryDto:
type: object
properties:
fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FieldDto'
additionalProperties: false
description: This class represents single schema information from external data.
ObjectSearchResultDto:
type: object
properties:
id:
type:
- string
- 'null'
description: Id of the entity.
example: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
entityType:
enum:
- Company
- Individual
type:
- string
- 'null'
description: Type of the entity
fullName:
type:
- string
- 'null'
description: Full name of the entity
example: My Entity Name
matchHint:
type:
- string
- 'null'
description: Hint how entity is matching search (exact or partial).
example: Selected
matchScore:
type:
- number
- 'null'
description: Score how much entity matches the search request.
format: double
example: 25
data: {}
additionalProperties: false
ObjectObjectHierarchyDto:
type: object
properties:
associatedEntities:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectAssociatedPartyDto'
associations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectAssociationDto'
additionalProperties: false
ObjectDocumentsDto:
type: object
properties:
entityDocuments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectDocumentDto'
additionalProperties: false
GetResponseSchemaDto:
type: object
properties:
clientData:
$ref: '#/components/schemas/SchemaEntryDto'
associatedEntitiesCompanyData:
$ref: '#/components/schemas/SchemaEntryDto'
associatedEntitiesIndividualData:
$ref: '#/components/schemas/SchemaEntryDto'
associationsData:
$ref: '#/components/schemas/SchemaEntryDto'
additionalProperties: false
description: Schema for the "get" response.
PurchasedDocumentsDto:
type: object
properties:
id:
type:
- string
- 'null'
name:
type:
- string
- 'null'
type:
type:
- string
- 'null'
status:
type:
- string
- 'null'
fileLocation:
type:
- string
- 'null'
errorDetails:
$ref: '#/components/schemas/AdapterResponseErrorDetails'
additionalProperties: false
SchemaDto:
type: object
properties:
searchRequest:
$ref: '#/components/schemas/SearchRequestSchemaDto'
searchResponse:
$ref: '#/components/schemas/SearchResponseSchemaDto'
getRequest:
$ref: '#/components/schemas/GetRequestSchemaDto'
getResponse:
$ref: '#/components/schemas/GetResponseSchemaDto'
additionalProperties: false
description: Schema of the external data adapter.
ObjectAssociatedPartyDto:
type: object
properties:
id:
type:
- string
- 'null'
entityType:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
uboType:
type:
- string
- 'null'
isActive:
type:
- boolean
- 'null'
data: {}
additionalProperties: false
SearchResponseSchemaDto:
type: object
properties:
searchResultsData:
$ref: '#/components/schemas/SchemaEntryDto'
additionalProperties: false
description: Schema for the "search" response.
TestResponseDto:
type: object
properties:
adapterSchema:
$ref: '#/components/schemas/AdapterSchemaDto'
adapterSchemaIndividual:
$ref: '#/components/schemas/AdapterSchemaDto'
additionalProperties: false
description: 'Response for the "Test" request type.
It contains updated adapter schema for the provider.'
DocumentData:
type: object
properties:
extension:
type:
- string
- 'null'
additionalProperties: false
ObjectDocumentResultDto:
type: object
properties:
documentId:
type:
- string
- 'null'
description: Document Id
example: d046f87e-2f26-41d4-833a-ed57fb897ee6
fileLocation:
type:
- string
- 'null'
description: File Location in the Doc Storage
example: //path/file
status:
$ref: '#/components/schemas/DocumentResultStatus'
errorDetails:
$ref: '#/components/schemas/AdapterResponseErrorDetails'
data:
description: Generic data depending on the external provider, can contain specifics about the document.
receiveDate:
type:
- string
- 'null'
description: Receive date
format: date-time
example: '2021-01-01T14:48:00.000Z'
additionalProperties: false
AdapterResponseErrorDetails:
type: object
properties:
source:
type:
- string
- 'null'
description: Source of the error.
errorCode:
type:
- string
- 'null'
description: Error code specifying type of the error.
message:
type:
- string
- 'null'
description: Error message
additionalProperties: false
description: This class contains the error details if ther was an error with adapter request.
ObjectDocumentDto:
type: object
properties:
id:
type:
- string
- 'null'
name:
type:
- string
- 'null'
date:
type:
- string
- 'null'
format: date-time
data: {}
additionalProperties: false
CreateSignedUrlResponseDtoListServiceResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CreateSignedUrlResponseDto'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
additionalProperties: false
ServiceResponse:
type: object
properties:
data:
type:
- string
- 'null'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
additionalProperties: false
SearchRequestSchemaDto:
type: object
properties:
searchCriteria:
$ref: '#/components/schemas/SchemaEntryDto'
additionalProperties: false
description: Schema for the "search" request.
LookupDto:
type: object
properties:
name:
type:
- string
- 'null'
description: Name of the lookup
values:
type:
- array
- 'null'
items:
type: string
description: Values of the lookup that can be used.
additionalProperties: false
UltimateBeneficialOwnerResponseDto:
type: object
properties:
results:
$ref: '#/components/schemas/ObjectObjectUltimateBeneficialOwnerResultDto'
additionalProperties: false
description: Response from the external data adapter with ultimate beneficial owners information.
ObjectObjectUltimateBeneficialOwnerResultDto:
type: object
properties:
id:
type:
- string
- 'null'
description: Id of the ultimate beneficial owner entry.
entityId:
type:
- string
- 'null'
description: Entity ID for which the request was made to get ultimate beneficial owners.
status:
type:
- string
- 'null'
description: Status of the ultimate beneficial owner request.
fileLocation:
type:
- string
- 'null'
purchasedDocuments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PurchasedDocumentsDto'
hierarchy:
$ref: '#/components/schemas/ObjectObjectHierarchyDto'
errorDetails:
$ref: '#/components/schemas/AdapterResponseErrorDetails'
additionalProperties: false
ObjectAssociationDto:
type: object
properties:
parentId:
type:
- string
- 'null'
childId:
type:
- string
- 'null'
ownershipPercentage:
type:
- number
- 'null'
format: double
associationType:
type:
- string
- 'null'
data: {}
additionalProperties: false
CreateSignedUrlResponseDto:
type: object
properties:
url:
type:
- string
- 'null'
fileName:
type:
- string
- 'null'
additionalProperties: false
DocumentResponseDto:
type: object
properties:
results:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectDocumentResultDto'
additionalProperties: false
FieldDto:
type: object
properties:
name:
type:
- string
- 'null'
description: Name of the field.
example: myTextField
friendlyName:
type:
- string
- 'null'
description: Friendly name of the field, displayed in the UI for the user.
example: My Text Field
type:
enum:
- text
- number
- date
- select
- multiselect
- datagroup
- multidatagroup
type:
- string
- 'null'
description: Type of the field.
example: number
description:
type:
- string
- 'null'
description: Field description.
lookup:
type:
- string
- 'null'
description: Lookup related to the field, if field is of type "select" or "multiselect".
example: Country
fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FieldDto'
description: Collection of internal fields, if field is of type "datagroup" or "multidatagroup".
additionalProperties: false
description: This class represents single field information.
OngoingMonitoringUnsubscriptionResponseDto:
type: object
properties:
subscriptionId:
type:
- string
- 'null'
description: Subscription id of the unsubscribed data.
example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
data:
description: Generic data, depending on the external provider, can contain specifics of the entity to be unsubscribed.
additionalProperties: false
description: Response for ongoing monitoring unsubscription request.
SearchResponseDto:
type: object
properties:
results:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ObjectSearchResultDto'
description: List of results for the search request.
additionalProperties: false
description: Response for the "Search" request type.
AdapterResponseDto_2:
type: object
properties:
id:
type:
- string
- 'null'
description: Id of the request
example: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
tenant:
type:
- string
- 'null'
description: The tenant for which the request was for.
providerId:
type:
- string
- 'null'
description: Id of the external data provider.
example: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
type:
enum:
- Document
- Get
- Search
- Test
- Ubo
- OngoingMonitoringNotification
- OngoingMonitoringSubscription
- OngoingMonitoringUnsubscription
type:
- string
- 'null'
description: Type of the adapter response.
example: Search
status:
enum:
- Success
- Error
type:
- string
- 'null'
description: Status of the adapter response.
example: Success
errorDetails:
$ref: '#/components/schemas/AdapterResponseErrorDetails'
response:
oneOf:
- $ref: '#/components/schemas/GetResponseDto'
- $ref: '#/components/schemas/SearchResponseDto'
- $ref: '#/components/schemas/TestResponseDto'
- $ref: '#/components/schemas/DocumentResponseDto'
- $ref: '#/components/schemas/UltimateBeneficialOwnerResponseDto'
- $ref: '#/components/schemas/OngoingMonitoringSubscriptionResponseDto'
- $ref: '#/components/schemas/OngoingMonitoringNotificationResponseDto'
- $ref: '#/components/schemas/OngoingMonitoringUnsubscriptionResponseDto'
additionalProperties: false
OngoingMonitoringNotificationResponseDto:
type: object
properties:
entityId:
type:
- string
- 'null'
description: Entity ID for which notification was sent.
example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
eventType:
type:
- string
- 'null'
description: Event Type of the notification.
eventSubtype:
type:
- string
- 'null'
description: Subtype of the notification.
data:
description: Generic data depending on the external provider, can contain specifics about the entity change.
additionalProperties: false
description: This class represents the response for ongoing monitoring notification.
OngoingMonitoringSubscriptionResponseDto:
type: object
properties:
subscriptionId:
type:
- string
- 'null'
description: Id of subscription confirming the monitoring of the entity.
data:
description: Generic data, depending on the external provider, can contain specifics of the entity to be monitored.
additionalProperties: false
description: Response of the ongoing monitoring subscription.
ObjectClientDto:
type: object
properties:
id:
type:
- string
- 'null'
entityType:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
data: {}
additionalProperties: false
DocumentResultStatus:
enum:
- DocumentReceived
- DocumentFailed
type: string
description: 'Represents the status of a document result.
Allowed values: DocumentReceived, DocumentFailed'
AdapterSchemaDto:
type: object
properties:
lookups:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/LookupDto'
description: 'Collection of lookup information for the external data adapter schema.
Those lookups are used for the mapping of the external data to the Fenergo data model.'
schema:
$ref: '#/components/schemas/SchemaDto'
additionalProperties: false
description: Root entity for the external data adapter schema.
CreateSignedUrlRequestDto:
type: object
properties:
documentData:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DocumentData'
additionalProperties: false
ScreenResponseDto:
required:
- entities
type: object
properties:
batchExternalIds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BatchExternalIdDto'
description: List of Batch-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the "Batch" concept in Screening)
entities:
type: array
items:
$ref: '#/components/schemas/ScreenResponseEntityDto'
description: List of entities screened
additionalProperties: false
description: Response for the "Screen" request type
AdditionalInfoDto:
type: object
properties:
title:
type:
- string
- 'null'
description: Type of information
example: Last Updated
content:
type:
- array
- 'null'
items:
type: string
description: Content of the additional information
example:
- 7/5/2022 12:00:00 AM +01:00
additionalProperties: false
description: Class to represent additional information returned by the providers
IdDetails:
type: object
properties:
type:
type:
- string
- 'null'
description: The Type of Id of the entity
example: Passport, Driving License
value:
type:
- string
- 'null'
description: This is the Value of the ID of the entity
example: D0999971, 000012ABCD
country:
type:
- string
- 'null'
description: ID Issuing Country
example: Ireland, USA
label:
type:
- string
- 'null'
description: The human-readable name of the ID scheme, as reported by the underlying provider (e.g. the name of a registry or identifier scheme)
example: National Registry of Legal Entities (CNPJ)
issueDate:
type:
- string
- 'null'
description: Date on which Id is Issued.
example: 31/12/1989
expiryDate:
type:
- string
- 'null'
description: Date on which ID expires
example: 31/12/1989
additionalProperties: false
TestResponseDto_2:
type: object
additionalProperties: false
description: "Response for the \"Test\" request type. \n\nThere are no properties in this class because no additional data is required to process it."
CategoryDetailRowDto:
type: object
properties:
fields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CategoryDetailFieldDto'
description: The labelled fields for this row
subRows:
type:
- array
- 'null'
items:
type: array
items:
$ref: '#/components/schemas/CategoryDetailFieldDto'
description: 'Per-row sub-table, e.g. SOE''s per-country ownership breakdown. Null/empty for every
category kind that has no such breakdown.'
additionalProperties: false
description: One row of a category detail table - one PEP hit, one Sanction hit, etc.
OngoingScreeningGetResultsResponseEntityDto:
required:
- legalEntityId
- matchesData
type: object
properties:
entityId:
type:
- string
- 'null'
description: The Screening internal ID of the entity
example: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
deprecated: true
legalEntityId:
minLength: 1
type: string
description: The unique ID of the entity in Fen-X
example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
externalIds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ExternalIdDto'
description: List of Entity-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the "Entity" concept in Screening)
matchesData:
type: array
items:
$ref: '#/components/schemas/MatchDataDto'
description: List of matches of the entity
configurationSetId:
type:
- string
- 'null'
description: The ID of the configuration set used for this screening. If not provided, the default configuration set of the provider will be assumed
format: uuid
additionalProperties: false
description: Class to represent the screening results of an entity
AddressDto:
type: object
properties:
addressLine1:
type:
- string
- 'null'
description: The first line in the address
example: 158, Upper O'Connell Street
addressLine2:
type:
- string
- 'null'
description: The second line in the address
example: Dublin 1
city:
type:
- string
- 'null'
description: The city
example: Dublin
postalCode:
type:
- string
- 'null'
description: The postal code
example: D01YT95
country:
type:
- string
- 'null'
description: The country
example: Ireland
countryISO2:
type:
- string
- 'null'
description: The country ISO2 code
example: IE
countryISO3:
type:
- string
- 'null'
description: The country ISO3 code
example: IRL
stateProvince:
type:
- string
- 'null'
description: The state or province
example: Leinster
type:
type:
- string
- 'null'
description: The type of address
example: Main address
category:
type:
- string
- 'null'
description: 'The category of the address (e.g. Residential, Business, Headquarters, Ownership), as
reported by the underlying provider'
example: Residential
additionalProperties: false
description: Class to represent the address of an entity
ObjectAdapterResponseDto:
required:
- id
- providerId
- status
- tenant
- type
type: object
properties:
id:
minLength: 1
type: string
description: 'Field used to uniquely identify the request. It''s value is different depending on the response type:
- For the "Screen" and "ResolveMatches" types, it should be the Screening BatchId
- For the "Test" type, it should be the Screening ConfigurationId
- For the "OngoingScreeningGetResults" type, the BatchId is not available, so it should be an unique string
that hasn''t been used before. For example, "ogs-{auto-generated Guid}"
'
example: fd23f474-eff9-425f-a776-78e2176b36e4
tenant:
minLength: 1
type: string
description: The tenant of the client
example: 095d6a21-b5cf-4369-9491-0de90438e26c
providerId:
minLength: 1
type: string
description: The Screening internal ID of the provider. Must match the ID of the provider in the configuration
example: MyProviderId
type:
minLength: 1
enum:
- Screen
- ResolveMatches
- Test
- OngoingScreening
- OngoingScreeningUpdate
- OngoingScreeningGetResults
type: string
description: The type of the request
example: Screen
status:
minLength: 1
enum:
- Success
- Error
type: string
description: Property used to specify the status of the request
example: Success
errorDetails:
$ref: '#/components/schemas/AdapterResponseErrorDetails_2'
response:
oneOf:
- $ref: '#/components/schemas/ScreenResponseDto'
- $ref: '#/components/schemas/ResolveMatchesResponseDto'
- $ref: '#/components/schemas/TestResponseDto_2'
- $ref: '#/components/schemas/OngoingScreeningResponseDto'
- $ref: '#/components/schemas/OngoingScreeningUpdateResponseDto'
- $ref: '#/components/schemas/OngoingScreeningGetResultsResponseDto'
description: "Generic property that represents the data of the response. \n\nThe type to used will be determined by the type of response specified in the field \"type\". \n\nMust be `null` when !:UploadId is set — the receptor will download the\nresponse payload from S3 using the upload ID instead of reading it from this field."
additionalProperties: false
description: Class to represent a response from a Screening adapter
OngoingScreeningGetResultsResponseDto:
type: object
properties:
batchExternalIds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BatchExternalIdDto'
description: List of Batch-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the "Batch" concept in Screening)
entities:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/OngoingScreeningGetResultsResponseEntityDto'
description: List of entities screened
additionalProperties: false
description: Response for the "OngoingScreeningGetResults" request type
ProviderSourceLinkDto:
type: object
properties:
url:
type:
- string
- 'null'
description: URL of the match on the provider side.
example: https://myprovider.com/match/1
label:
type:
- string
- 'null'
description: Label for the URL link.
example: View in MyProvider
entityAliasId:
type:
- string
- 'null'
description: What entity Alias this ProviderSourceLink is associated with.
example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e
additionalProperties: false
description: Represents a URL link to the match on the provider's side, with an optional label.
AdapterResponseErrorDetails_2:
required:
- source
type: object
properties:
source:
minLength: 1
type: string
description: Property to specify where the error is coming from
example: Adapter
errorCode:
type:
- string
- 'null'
description: If available, the error code
example: E001
message:
type:
- string
- 'null'
description: The error message to understand what has failed
example: The provider returned an invalid status code (500)
additionalProperties: false
description: Class to represent the error details of a request to a Screening adapter
OngoingScreeningUpdateResponseDto:
type: object
additionalProperties: false
description: "Response for the \"OngoingScreeningUpdate\" request type \n\nThere are no properties in this class because no additional data is required to process it."
CategoryDetailFieldDto:
type: object
properties:
label:
type:
- string
- 'null'
description: The display label for this field
example: Status
value:
type:
- string
- 'null'
description: The value of this field
example: Inactive
additionalProperties: false
description: One labelled field within a category detail row (e.g. Label="Status", Value="Inactive")
AssociationDto:
type: object
properties:
externalId:
type:
- string
- 'null'
description: 'The unique identifier of the Associated Entity outside of Fen-X (i.e. in the underlying provider).
Used to query the underlying provider for more information about the associated entity.'
example: e_tr_wco_2256753
category:
type:
- string
- 'null'
description: Category of additional information
example: Enforcements,AdverseMedia:CORPORATE
fullName:
type:
- string
- 'null'
description: The name of the associated party
example: Test Entity
relationship:
type:
- string
- 'null'
description: How the entity and the associated party are related i.e shareholder, director
example: AFFILIATED_COMPANY
relationshipGroup:
type:
- string
- 'null'
description: The relationship group as reported by the underlying provider (e.g. Family, Associations)
example: Family
ownershipPercentage:
type:
- number
- 'null'
description: The ownership percentage of the associated party, as reported by the underlying provider
format: double
example: 19.74
additionalProperties: false
description: Class to represent a relationship with another entity
MatchDataAliasDto:
type: object
properties:
value:
type:
- string
- 'null'
description: The value of the alias
example: TE
type:
type:
- string
- 'null'
description: The type of alias
example: Acronym
additionalProperties: false
description: Class to represent the alias of an entity
ScreenResponseEntityDto:
required:
- entityId
type: object
properties:
entityId:
minLength: 1
type: string
description: The Screening internal ID of the entity
example: 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27
externalIds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ExternalIdDto'
description: List of Entity-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the "Entity" concept in Screening)
matchesData:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/MatchDataDto'
description: List of matches of the entity
additionalProperties: false
description: Class to represent the screening results of an entity
OngoingScreeningResponseDto:
type: object
additionalProperties: false
description: "Response for the \"OngoingScreening\" request type \n\nThere are no properties in this class because no additional data is required to process it."
BatchExternalIdDto:
required:
- name
- source
type: object
properties:
source:
minLength: 1
type: string
description: The source of this externalId (LN, WCO, etc)
example: MyProviderId
name:
minLength: 1
type: string
description: The name of the ID in the provider
example: FieldInProvider
value:
type:
- string
- 'null'
description: The value of the ID
example: '1234'
additionalProperties: false
description: Class to represent the batch external IDs fetched from the providers (runId, resultId, etc)
CategoryDetailDto:
type: object
properties:
kind:
enum:
- Pep
- Sanction
- Enforcement
- AdverseMedia
- Soe
- Registration
- Other
type:
- string
- 'null'
description: The category this table's rows belong to
example: Pep
rows:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CategoryDetailRowDto'
description: The rows of this category's table
additionalProperties: false
description: One category's worth of structured detail rows (e.g. every PEP hit for this match)
MatchDataExternalIdDto:
type: object
properties:
entityAliasId:
type:
- string
- 'null'
description: What entity Alias this externalId is associated with. Will be "PrimaryName" for the PrimaryName external ids
example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e
value:
type:
- string
- 'null'
description: The value of the ID
example: '1234'
additionalProperties: false
description: Class to represent a match external id
MatchDataDto:
required:
- providerId
- providerSourceName
type: object
properties:
externalId:
type:
- string
- 'null'
description: "The unique identifier of the match outside of Fen-X (i.e. in the underlying provider). \n\nIt will be used later on to resolve the matches on the provider side. \n\nIf using Alias Screening, this will be the ExternalId of the first entity in which this match appears.\nSo instead of using this field, ExternalIds should be used, as it contains the ExternalId for each of the aliases the match belongs to."
example: '1234'
deprecated: true
externalIds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/MatchDataExternalIdDto'
description: "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\nThey will be used later on to resolve the matches on the provider side. There will be one (or more) ExternalId\nfor each of the entity alias ids related to this match"
providerId:
minLength: 1
type: string
description: "The ID of the provider that returned the match. \n\nMust match the ID of the provider in the Screening configuration."
example: MyProviderId
entityAliasIds:
type:
- array
- 'null'
items:
type: string
description: 'List of the FenX Entity AliasIds that this match is associated with for Alias Screening feature.
When it''s associated with the primary name of the entity, one of them will be "PrimaryName".
If the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.'
name:
type:
- string
- 'null'
description: The name of the matching entity
example: Test Entity
aliases:
type:
- array
- 'null'
items:
type: string
description: Any aliases associated with the matching entity, formatted as a list of strings
example:
- Alias1
- Alias2
deprecated: true
aliasesList:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/MatchDataAliasDto'
description: Any aliases associated with the matching entity, formatted as a list of AliasDto
gender:
enum:
- Male
- Female
type:
- string
- 'null'
description: The Individual's gender
example: Female
dateOfBirth:
type:
- string
- 'null'
description: The Individual's date of birth in DD/MM/YYYY format
example: 25/01/1950
deprecated: true
dateOfBirthList:
type:
- array
- 'null'
items:
type: string
description: List of Individual's date of birth in DD/MM/YYYY format from different Providers
country:
type:
- string
- 'null'
description: The country of the entity
example: Ireland
entityType:
enum:
- Individual
- Company
- Other
type:
- string
- 'null'
description: The type of entity
example: Individual
matchScore:
type: number
description: A confidence score generated by the screening provider to indicate how closely the result record matched the searched entity data.
format: double
example: 100
providerSourceName:
minLength: 1
type: string
description: "The name of the screening provider. \n\nShould match the provider name provided in the Screening configuration"
example: MyProviderName
providerSourceUrl:
type:
- string
- 'null'
description: "URL of the match on the provider side. \n\nLeave empty if the provider doesn't have a portal where the user could go to check the match details on their side"
example: https://myprovider.com/match/{matchId}
deprecated: true
providerSourceUrls:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ProviderSourceLinkDto'
description: "List of URL links to the match on the provider's side, each with an optional label. \n\nLeave empty if the provider doesn't have a portal where the user could go to check the match details on their side."
addresses:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AddressDto'
description: List of addresses of the individual or the company
citizenship:
type:
- string
- 'null'
description: The individual's citizenship
example: Irish
deprecated: true
nationality:
type:
- string
- 'null'
description: The individual's nationality
example: Irish
deprecated: true
placeOfBirth:
type:
- string
- 'null'
description: The individual's place of birth
example: Ireland
deprecated: true
citizenshipList:
type:
- array
- 'null'
items:
type: string
description: List of Individual's citizenships
nationalityList:
type:
- array
- 'null'
items:
type: string
description: List of Individual's nationalities
placeOfBirthList:
type:
- array
- 'null'
items:
type: string
description: List of Individual's place of birth from different Providers
countryOfResidence:
type:
- string
- 'null'
description: The individual's country of residence
example: Ireland
additionalInfo:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AdditionalInfoDto'
description: "Dynamic list to provide additional information about the matching entity. \n\nThe data provided here is rendered in the \"Profile\" section in the Fen-X UI."
example:
- Title: Last Updated
Content:
- 7/5/2022 12:00:00 AM +01:00
sourcesInfo:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AdditionalInfoDto'
description: "Dynamic list to provide details about the source of the information returned by the provider. \n\nThe data provided here is rendered in the \"Sources\" section in the Fen-X UI, each occurrence having its own subsection based on the \"Title\" provided. \n\nIf both Sources and SourcesInfo are sent, in the UI, Sources will be used and SourcesInfo will be ignored."
example:
- Title: Entity URL
Content:
- URL1
- URL2
categories:
enum:
- AdverseMedia
- Enforcements
- Other
- Pep
- Sanctions
type:
- array
- 'null'
items:
type: string
description: List of screening categories that the result relates to
example:
- PEP
- Sanctions
sources:
type:
- array
- 'null'
items:
type: string
description: "Dynamic list to provide details about the source of the information returned by the provider. \n\nThe data provided here is rendered in the \"Sources\" section in the Fen-X UI. All occurrences are listed under a \"Sources\" subsection in the section. \n\nIf both Sources and SourcesInfo are sent, in the UI, Sources will be used and SourcesInfo will be ignored."
example:
- URL1
- URL2
registeredCountry:
type:
- string
- 'null'
description: The country the company is registered in
example: Ireland
ids:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
description: List of ids returned by the underlying provider
example:
Id1: '158192327'
Id2: '1465465'
deprecated: true
idsList:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IdDetails'
description: List of Ids returned by the underlying provider
associations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AssociationDto'
description: List of entities associated to the entity being screened
status:
enum:
- Match
- No Match
- Unresolved
type:
- string
- 'null'
description: The status of the match
example: Unresolved
reason:
type:
- string
- 'null'
description: The reason why the match has the status specified in the property "Status"
example: ''
comments:
type:
- string
- 'null'
description: Additional comments about the match resolution
example: ''
subsidiaryFields:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
description: An optional dictionary used to add custom fields required by some adapters or providers
richTextAdditionalDetails:
type:
- string
- 'null'
description: An optional property to store additional details about the match in rich text format
categoryDetails:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CategoryDetailDto'
description: 'WC Data Plus structured category data (PEP, Sanction, Enforcement, Adverse Media, SOE,
Registration, Other), one entry per populated category kind that has at least one row.
Can be left null/empty for every other provider that don''t need to provide structured category data.'
additionalProperties: false
description: Class to represent the details of a Screening match
ExternalIdDto:
required:
- name
- source
type: object
properties:
source:
minLength: 1
type: string
description: The source of this externalId (LN, WCO, etc)
example: MyProviderId
entityAliasId:
type:
- string
- 'null'
description: What entity Alias this externalId is associated with. Will be null or "PrimaryName" for the PrimaryName external ids
example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e
name:
minLength: 1
type: string
description: The name of the ID in the provider
example: FieldInProvider
value:
type:
- string
- 'null'
description: The value of the ID
example: '1234'
additionalProperties: false
description: Class to represent the external IDs fetched from the providers (runId, resultId, etc)
ResolveMatchesResponseDto:
type: object
additionalProperties: false
description: "Response for the \"ResolveMatches\" request type \n\nThere are no properties in this class because no additional data is required to process it."
x-refined-from:
- fenergo-creditscreeningreceptor-v1-0-openapi.json
- fenergo-externaldatareceptor-v1-0-openapi.json
- fenergo-screeningreceptor-v1-0-openapi.json