Fenergo Batch API
The Batch API from Fenergo — 39 operation(s) for batch.
Fenergo Batch API is one of 281 APIs that Fenergo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 39 operations across 39 paths, and defines 90 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: /screeningcommand, /screeningquery.
39 operations
39 paths
90 schemas
2 DELETE17 GET8 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Fenergo Batch API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
By default, every request must be authenticated.
Bearer— Please insert JWT with Bearer into field
Paths & Operations 39
Across 39 paths, the API surfaces 39 operations — 2 DELETE, 17 GET, 8 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
Batch 39
POST
/api/batch
Create a new screening batch to screen one or more entities
PUT
/api/batch/{id}/complete
Complete an existing screening batch
PUT
/api/batch/{id}/matches
Update a list of matches in a batch
PUT
/api/batch/{id}/entity/{entityId}/updatemateriality
Update the materiality assessment of an Entity's related party in ongoing…
POST
/api/v2/batch
Create a new screening batch to screen one or more entities
PUT
/api/v2/batch/{id}/complete
Complete an existing screening batch
PUT
/api/v2/batch/{id}/matches
Update a list of matches in a batch
PUT
/api/v2/batch/{id}/entity/{entityId}/updatemateriality
Update the materiality assessment of an Entity's related party in ongoing…
POST
/api/v3/batch
Create a new screening batch to screen one or more entities
PUT
/api/v3/batch/{id}/complete
Complete an existing screening batch
PUT
/api/v3/batch/{id}/matches
Update a list of matches in a batch
PUT
/api/v3/batch/{id}/entity/{entityId}/updatemateriality
Update the materiality assessment of an Entity's related party in ongoing…
PUT
/api/v3/batch/{id}/entity/{entityId}
Updates an existing Screening Batch Entity with the data supplied in the…
PUT
/api/v3/batch/{id}/entity/{entityId}/escalatematerialitytask
Escalates a materiality assessment task to second-line review
PUT
/api/v3/batch/{id}/entity/{entityId}/deescalatematerialitytask
De-escalates a materiality assessment task
POST
/api/v3/batch/{id}/entity/{entityId}/documents/upload-url
Initiates an entity document upload by returning a pre-signed URL
POST
/api/v3/batch/{id}/entity/{entityId}/documents/reuse
Reuses an existing document uploaded previously to the entity specified in the…
DELETE
/api/v3/batch/{id}/entity/{entityId}/documents/{documentId}
Deletes an entity document reference from a batch entity
POST
/api/v3/batch/{id}/entity/{entityId}/match/{matchId}/documents/upload-url
Generates a pre-signed URL for uploading a document to a match hit
POST
/api/v3/batch/{id}/entity/{entityId}/match/{matchId}/documents/reuse
Reuses an existing document uploaded previously to the match specified in the…
DELETE
/api/v3/batch/{id}/entity/{entityId}/match/{matchId}/documents/{documentId}
Deletes a match document reference from a batch match
POST
/api/v3/batch/{id}/aggregate-entity-materiality
Calculates final materiality across all entities in the batch and writes the…
GET
/api/batch/{id}
Get data of an existing batch with batch Id
GET
/api/batch/journey/{journeyId}
Get data of an existing batch with journey Id
GET
/api/batch/journey/{journeyId}/process/{processId}
Get data of an existing batch with journey Id and process Id
GET
/api/batch/legalentity/{legalEntityId}
Get the batches with Legal Entity Id
GET
/api/v2/batch/{id}
Get data of an existing batch with batch Id
GET
/api/v2/batch/journey/{journeyId}
Get data of an existing batch with journey Id
GET
/api/v2/batch/journey/{journeyId}/process/{processId}
Get data of an existing batch with journey Id and process Id
GET
/api/v2/batch/legalentity/{legalEntityId}
Get the batches with Legal Entity Id
GET
/api/v3/batch/{id}
Get data of an existing batch with batch Id
GET
/api/v3/batch/journey/{journeyId}
Get data of an existing batch with journey Id
GET
/api/v3/batch/journey/{journeyId}/process/{processId}
Get data of an existing batch with journey Id and process Id
GET
/api/v3/batch/legalentity/{legalEntityId}
Get the batches with Legal Entity Id
GET
/api/v4/batch/{id}
Get data of an existing batch with batch Id
GET
/api/v4/batch/journey/{journeyId}
Get data of an existing batch with journey Id
GET
/api/v4/batch/journey/{journeyId}/process/{processId}
Get data of an existing batch with journey Id and process Id
GET
/api/v4/batch/legalentity/{legalEntityId}
Get the batches with Legal Entity Id
GET
/api/v4/batch/entity/{entityId}/materiality-assessment-history
Get the materiality assessment history for a specific entity
Schemas 90
The contract defines 90 schemas that model the data the API accepts and returns. The most detailed are SearchCriteriaDto (30 properties), SearchCriteriaDto_2 (30 properties), SearchCriteriaDtoV2 (30 properties), SearchCriteriaDto_4 (30 properties). Each schema is shown below with its type and property counts.
ServiceResponseMessage
object
3 properties
SearchCriteriaDto
object
The search criteria of the entity that will be used to perform screening requests
30 properties
1 required
StringServiceResponse
object
2 properties
CreateBatchEntityDto
object
Represents the entity in the create batch request
3 properties
1 required
PropertyDto
object
1 property
ClassificationDataDto
object
1 property
ObjectServiceResponse
object
2 properties
ServiceResponse
object
2 properties
PropertyType
string
AddressDto
object
Represents the address dto
9 properties
CreateBatchProviderDto
object
Represents a provider within the context of a create batch request
2 properties
1 required
ClassificationDataSinglePropertyDto
object
2 properties
UpdateMaterialityAssessmentDto
object
Represents the materiality assessment of a related party
2 properties
1 required
UpdateEntityMatchesDto
object
Represents the entity in the UpdateEntityMatches request
2 properties
1 required
UpdateEntityMatchesDtoListServiceRequest
object
1 property
UpdateMatchDto
object
Represents the match in the UpdateEntityMatches request
6 properties
2 required
EntityAliasDto
object
Class to represent a Screening entity Alias
7 properties
1 required
UpdateMaterialityAssessmentDtoServiceRequest
object
1 property
BatchCreatedDto
object
Represents the data of a batch that has been created
1 property
BatchCreatedDtoServiceResponse
object
2 properties
CreateBatchDto
object
Represents the create batch request
4 properties
1 required
CreateBatchDtoServiceRequest
object
1 property
FinalMaterialityResultDtoServiceResponse
object
2 properties
EntityMaterialityAssessmentSanctionsResultDto
object
Represents the result of a Sanctions materiality assessment.
4 properties
FinalMaterialityResultDto
object
6 properties
EscalateMaterialityAssessmentTaskDto
object
Represents a request to escalate a materiality task within a batch for second-line review
3 properties
2 required
ReuseMatchDocumentDto
Request body for reusing an existing match document from another batch.
UpdateBatchEntityDto
object
Represents a request to update BatchEntity properties
2 properties
ProblemDetails
object
5 properties
CreateBatchDtoV3ServiceRequest
object
1 property
CreateBatchDtoV3
object
5 properties
1 required
SearchCriteriaDtoV3
object
The search criteria of the entity that will be used to perform screening requests
30 properties
1 required
ReuseDocumentDtoBase
object
Base class for reuse document request DTOs, carrying the shared required fields.
2 properties
2 required
ReuseEntityDocumentDtoServiceRequest
object
1 property
UploadEntityDocumentResponseDtoServiceResponse
object
2 properties
UploadMatchDocumentResponseDtoServiceResponse
object
2 properties
CreateBatchEntityDtoV3
object
3 properties
1 required
ImpactedClientDto
object
Represents a client impacted by a confirmed OGS hit, with the compliance officer's decision on whether a follow-up ODS journey should be triggered.
3 properties
UploadDocumentDtoBase
object
Base class for upload document request DTOs, carrying the shared required fields.
4 properties
2 required
UpdateBatchEntityDtoServiceRequest
object
1 property
EntityMaterialityAssessmentDto
object
Represents the materiality assessment details for a batch entity, including materiality assessment results for PEP, sanctions, adverse media, enforcements, and…
7 properties
ReuseEntityDocumentResponseDtoServiceResponse
object
2 properties
ReuseMatchDocumentDtoServiceRequest
object
1 property
UploadMatchDocumentDto
Request body for initiating a match document upload.
ReuseMatchDocumentResponseDtoServiceResponse
object
2 properties
UploadMatchDocumentResponseDto
object
Response DTO returned after initiating a match document upload.
3 properties
UploadEntityDocumentDtoServiceRequest
object
1 property
EscalateMaterialityAssessmentTaskDtoServiceRequest
object
1 property
ReuseEntityDocumentDto
Request body for reusing an existing entity document from another batch.
EntityMaterialityAssessmentResultDto
object
Represents the result of a materiality assessment.
2 properties
UploadEntityDocumentDto
Request body for initiating an entity document upload.
ReuseEntityDocumentResponseDto
object
Response DTO returned after successfully reusing an entity document.
1 property
ReuseMatchDocumentResponseDto
object
Response DTO returned after successfully reusing a match document.
1 property
UploadEntityDocumentResponseDto
object
Response DTO returned after initiating an entity document upload.
3 properties
UploadMatchDocumentDtoServiceRequest
object
1 property
BatchProviderDto
object
Represents a Provider in a Screening batch
4 properties
2 required
AdapterResponseErrorDetailsDto
object
Represents the error details in a specific provider
3 properties
2 required
BatchDtoServiceResponse
object
2 properties
BatchDto
object
Represents a Screening batch
22 properties
6 required
BatchMetadataDto
object
Represents metadata associated with a screening batch
3 properties
EntityAliasDto_2
object
Class to represent a Screening entity Alias
7 properties
LegalEntityBatchDtoIEnumerableServiceResponse
object
2 properties
SearchCriteriaDto_2
object
Represent the Search Criteria to perform a Screen request
30 properties
1 required
AddressDto_2
object
Represents the address of an entity
10 properties
BatchExternalIdDto
object
Dto to represent the external IDs fetched from the providers (runId, resultId, etc)
3 properties
BatchEntitySearchDto
object
Represents an Entity in a Screening batch
4 properties
1 required
LegalEntityBatchDto
object
Represents a Batch in the GetBatchesByLegalEntityId request
7 properties
3 required
EntityAliasDto_3
object
Class to represent a Screening entity Alias
7 properties
SearchCriteriaDto_3
object
Represent the Search Criteria to perform a Screen request
30 properties
1 required
AddressDto_3
object
Represents the address of an entity
10 properties
BatchEntitySearchDto_2
object
Represents an Entity in a Screening batch
4 properties
1 required
EntityAliasDto_4
object
Class to represent a Screening entity Alias
7 properties
SearchCriteriaDto_4
object
Represent the Search Criteria to perform a Screen request
30 properties
1 required
AddressDto_4
object
Represents the address of an entity
10 properties
BatchEntitySearchDto_3
object
Represents an Entity in a Screening batch
4 properties
1 required
BatchDtoV2ServiceResponse
object
2 properties
EntityMaterialityAssessmentMatchDto
object
Represents a point-in-time snapshot of a match that influenced the materiality decision at the moment the Fenergo.Nebula.Screening.Query.Application.Dto.Entity…
5 properties
EntityMaterialityAssessmentSanctionsResultDto_2
object
Represents the result of a Sanctions materiality assessment.
4 properties
BatchEntityMaterialityHistoryDtoIEnumerableServiceResponse
object
2 properties
BatchEntityMaterialityHistoryDto
object
DTO for entity materiality assessment history
10 properties
SearchCriteriaDtoV2
object
Represent the Search Criteria to perform a Screen request
30 properties
1 required
EntityMaterialityAssessmentWithTrueMatchesDto
object
DTO that combines a materiality assessment with the point-in-time true match snapshots. Used exclusively by Fenergo.Nebula.Screening.Query.Application.Dto.Batc…
2 properties
AddressDto_5
object
Represents the address of an entity
10 properties
EntityMaterialityAssessmentLastActionedByDto
object
DTO representing the last action taken on an entity materiality assessment. Includes the user or client that performed the action and the timestamp of when it…
4 properties
EntityMaterialityAssessmentDto_2
object
Represents the materiality assessment details for a batch entity, including materiality assessment results for PEP, sanctions, adverse media, enforcements, and…
8 properties
EntityAliasDto_5
object
Class to represent a Screening entity Alias
7 properties
BatchDtoV2
object
Represents a Screening batch
17 properties
5 required
AccessLayersDto
object
Represents the access layer configuration controlling visibility of a resource.
2 properties
EntityMaterialityAssessmentResultDto_2
object
Represents the result of a materiality assessment.
2 properties
BatchEntitySearchDtoV2
object
Represents an Entity in a Screening batch
4 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Fenergo 12
Other APIs Fenergo publishes across the network.
Fenergo Acceptable Document API
Fenergo Access Layer API
Fenergo Adapter Mock API
Fenergo Advanced Dashboard API
Fenergo Agency API
Fenergo Agent API
Fenergo Agent Slos API
Fenergo Agent Value Story API
Fenergo Aggregation API
Fenergo Allocation API
Fenergo Allocation Configuration API
Fenergo Asset API
#Batch
Where this information came from
This is an independent, third-party profile of Fenergo Batch API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.