# Namirial Onboarding API Namirial Onboarding API **Do you support non-breaking changes?** A non-breaking change means that we are able to change some aspects of the API and it should not affect your integration. For instance, changes at API level listed below should not carry out any inconvenience to your integration: - Adding new response fields. - Adding new response headers. - Adding new endpoints / operations. - Adding new optional parameters in the requests. - Changing the order of properties in existing API responses. - Changing the length or format of strings and string based ids. Version: 2.0.0 ## Servers ``` https://test-eu-ie1-api.namirialonboarding.com/api/v2 ``` ## Security ### ApiKeyAuth Type: apiKey In: header Name: X-Api-Key ### bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Namirial Onboarding API](https://docs.namirial.app/_bundle/products/namirialonboarding/openapi-1.yaml) ## Request API Set of APIs for creating new instances of requests and retrieving their details. ### Create a new request - [POST /requests](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestspost.md) ### Get requests - [GET /requests](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestsget.md): Sorting Fields: - createdAt - updatedAt Note: Due to caching mechanism the bulk view may not be in sync with single request detail view. ### Generate Requests Export - [POST /requests/export](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestsexport.md) ### Get request - [GET /request/{id}](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidget.md) ### Modify a request in status DRAFT - [PUT /request/{id}](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidput.md) ### Publish a request in status DRAFT - [POST /request/{id}/creation](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidcreationpost.md) ### Generate new links associated to a request. Previous links (if not expired) are still usable. - [POST /request/{id}/links](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidlinkspost.md) ### Retrieves resources from a request as a ZIP archive - [POST /request/{id}/resources/archive](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidresourcesarchivepost.md) ### Retrieve resources from a request - [POST /request/{id}/resources/links](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidresourceslinkpost.md) ### Get request Identifications - [GET /request/{id}/identifications](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestididentifications.md) ### Get request identification detail. - [GET /request/{id}/identification](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestididentificationidget.md) ### Upload resource to a draft request - [POST /request/{id}/upload](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestiduploadpost.md) ### Retrieves the CA22D module PDFs for the given requestId and actorId - [GET /request/{id}/actor/{actor}/ca22d](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-api/requestidactoridca22dget.md) ## Request Type API Set of APIs for getting info about request types ### Get request type webhooks configurations - [GET /requestType/{id}/webhookConfigurations](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-type-api/requesttypeidwebhookconfigurationsget.md) ### Create request type webhooks setting - [POST /requestType/{id}/webhookConfigurations](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-type-api/requesttypeidwebhookconfigurationpost.md) ### Delete the specified webhook setting - [DELETE /requestType/{id}/webhookConfiguration/{webhookConfigurationId}](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-type-api/requesttypeidwebhookconfigurationiddelete.md) ### Get default public request type settings - [GET /requestType/{id}/settings](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-type-api/requesttypeidsettingsget.md) ### Add, delete or modify the default public request type settings - [PUT /requestType/{id}/settings](https://docs.namirial.app/products/namirialonboarding/openapi-1/request-type-api/requesttypeidsettingsput.md) ## Data Enrichment API Set of APIs for Data Enrichment ### Retrieves the request's Data Enrichments with simpler details - [GET /request/{id}/dataEnrichments/simple](https://docs.namirial.app/products/namirialonboarding/openapi-1/data-enrichment-api/requestiddataenrichmentssimpleget.md) ## DataHub API Set of APIs for managing self-contained DataHub workflows that enable identity verification through advanced data intelligence. These APIs allow clients to initiate, monitor, and retrieve results from processes involving data analysis, validation, and matching against trusted sources as part of digital onboarding and compliance procedures. ### Initiates a data intelligence workflow for identity verification - [POST /dataHub](https://docs.namirial.app/products/namirialonboarding/openapi-1/datahub-api/requestdataintelligencepost.md): Starts a Data Intelligence process to collect and analyze personal data for the purpose of verifying a user's identity. This may involve checks against official records, biometric data, and other sources to validate the identity in compliance with onboarding and regulatory requirements. ### Retrieves the status and results of a data intelligence process - [GET /dataHub/{id}](https://docs.namirial.app/products/namirialonboarding/openapi-1/datahub-api/requestdataintelligenceget.md): Fetches the current status and results of a previously initiated Data Intelligence process identified by the given ID. The response may include data validation outcomes, identity verification results, and other relevant insights gathered during the analysis. ## Signature API ### Get Signature associated to a request - [GET /request/{id}/signatures](https://docs.namirial.app/products/namirialonboarding/openapi-1/signature-api/requestidsignatureget.md)