The public Sinpex API facilitates automating the KYC process for onboarding prospective customers. This is achieved by creating Cases with designated workflow automation configuration via Projects.
\nSinpex automates the KYC process for potential business clients.
\nThis API enhances automation capabilities further by enabling the programmable creation and management of Cases, in addition to sending essential notifications through webhooks for important updates.
\nThe Sinpex API is organized around REST. Our API aims to provide predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes and verbs and OAuth authentication.
\nIt is strongly recomended that a client sends Accept: application/json header with all the requests so it assures getting JSON encoded responses.
This section will give an overview of the used concepts and resources that the Sinpex API uses to provide its functionality.
\nWhen onboarding a potential customer for your organization, a Case for this potential customer or company needs to be created in order to download required official documents, track the progress and add essential information that is required by the relevant compliance laws.
\nCreating a Case always needs to happen in the context of a specific Project, which determines what the required process for the potential customer should be.
\n\n\nNote: This resource is not available via the Sinpex API currently, however understanding the concept is relevant to understand how the Sinpex API works
\n
Projects determine the process of how to onboard a Case by defining which information needs to be resolved (via Questions) and the required automation process (via Workflow States).
\nThis configuration is typically done internally by Sinpex after a Target Operating Model (TOM) workshop to see which requirements are applicable for your use cases. Since the requirements for onboarding often depends on a lot of factors, this process is not automated and not available via the Sinpex API.
\n\n\nNote: This resource is not available via the Sinpex API currently, however understanding the concept is relevant to understand how the Sinpex API works
\n
The workflow automation defines the different stages of the onboarding by providing individual Workflow States. Sinpex provides a Visual Management Board with vertical \"columns\" to keep track of the current state of a specific Case.
\nEvery Workflow State can be configured with a number of automation rules to either halt or continue to another specific Workflow State. These are typically discussed in the Target Operating Model (TOM) workshop.
\n\n\nNote: This resource is not available via the Sinpex API currently, however understanding the concept is relevant to understand how the Sinpex API works
\n
A specific Workflow State can be configured with one or more Automation Rules which determine wether or not the Case can be moved to the next Workflow State.
\nBelow is the complete list of currently supported Automation Rules, and for more information please contact Sinpex support as we won't go into too much detail here.
\ncomplete_questions
check_thresholds
signatory_confirmation
ownership_confirmation
check_risks
check_documents
idv_profiles_verified
single_answer_matches_values
single_answer_forward_to_workflow_state
single_answer_is_above
single_answer_is_below
self_declarations_verified
idv_profiles_has_document
check_idv_profiles_with_self_declarations
ubo_drilldown
child_ubo_drilldown
check_idv
\n\nNote: This resource is not available via the Sinpex API currently, however understanding the concept is relevant to understand how the Sinpex API works
\n
The Questions define which information might be relevant for onboarding a potential customer. Some Questions can be indicated as required before continuing to a next Workflow State via automation rules.
\nEvery Question can be configured with a specific \"alias\", so it can also be used via the Sinpex API. These alias values can be configured via the Project and Question settings and are typically defined during the Target Operating Model (TOM) workshop.
\nThe Sinpex API uses OAuth authentication to obtain access to the API functionality.
\nIn order to onboard the potential customer, the most critical of the Questions need to be resolved, and this happens via the Answer resource. Typically, these are extracted from official documents, but can also be defined by the agents through the Sinpex UI.
\nHere is an overview of the available attribute for the Answer resources.
\nIn specific KYC processes, the potential customer needs to provide some of their information ahead of time which needs to be verified. This is supported via Self-Declared Value resources, typically they are compared agains Answers (extracted from official documents) although other resources are also possible (e.g. IDV Profiles).
\nHere is an overview of the Self-Declared Value attributes:
\nIn order to onboard a potential customer, relevant parties may need to be screened for any suspicious activity. This is supported via the Risk Profile resources.
\nIn order to onboard a potential customer, relevant persons of interest may need to be prompted for an identification and verification process. This is supported via the IDV Profile resources.
\nAs part of the IDV Profile mentioned above:
\nIn order to perform API requests, a Bearer token needs to be passed along with every API request. This is done via the Authorization header, in the format of Authorization: Bearer {{access_token}}. This access token can be obtained as shown by the Request Access Token request.
Reach out to the Sinpex support to obtain the client credentials for your specific environment.
\nThey should provide you with the client_id and client_secret which allow you to request access tokens.
If wanted, a complete Postman environment can also be provided to try out the requests in this documentation more easily.
\nIn some requests the \"validation rules\" section shows which validation is applied with a number of readable rule names. These are based on the Laravel Validation Rules.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Resource Overview","slug":"resource-overview"},{"content":"Obtaining access","slug":"obtaining-access"},{"content":"Validation Rules","slug":"validation-rules"}],"owner":"25915288","collectionId":"02e3399f-b960-4428-a3f1-fff0d276f952","publishedId":"2s9Y5ZwNRe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-29T19:12:05.000Z"},"item":[{"name":"Authentication","item":[{"name":"Request Access Token","event":[{"listen":"test","script":{"id":"12f44e04-77a1-4e26-b597-ba60f3255494","exec":["pm.test(\"Your test name\", function () {"," pm.response.to.have.status(200);"," var jsonData = pm.response.json();"," pm.environment.set(\"api_token\", jsonData.access_token);","});"],"type":"text/javascript"}}],"id":"4850297b-af57-42f3-bed5-15f0a96ad86e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{api_client_id}}\",\n \"client_secret\": \"{{api_client_secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/api/v2/oauth/token","urlObject":{"path":["api","v2","oauth","token"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"38d035bf-26d6-4dc1-bb61-b2e69136bf6a","name":"success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scope\": \"external\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/api/v2/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 18:41:41 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.5"},{"key":"pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' 'unsafe-eval' data: blob: *.sinpex.io https://www.gravatar.com/ https://cdn.datatables.net/ https://www.google.com/ https://www.gstatic.com/ https://cdn.jsdelivr.net/npm/alpinejs@3.12.0/dist/cdn.min.js https://cdn.jsdelivr.net/npm/echarts@4.9.0/dist/echarts-en.min.js https://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/pdfmake.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/vfs_fonts.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.css https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/img/jsoneditor-icons.svg;"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 31622400,\n \"access_token\": \"eyJ0eXAiOiJKV1...\"\n}"},{"id":"20c00497-7b47-46bb-84c3-95e264ec1f3b","name":"invalid-request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_secret\": \"{{api_client_secret}}\",\n \"scope\": \"external\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/api/v2/oauth/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 18:44:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' 'unsafe-eval' data: blob: *.sinpex.io https://www.gravatar.com/ https://cdn.datatables.net/ https://www.google.com/ https://www.gstatic.com/ https://cdn.jsdelivr.net/npm/alpinejs@3.12.0/dist/cdn.min.js https://cdn.jsdelivr.net/npm/echarts@4.9.0/dist/echarts-en.min.js https://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/pdfmake.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/vfs_fonts.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.css https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/img/jsoneditor-icons.svg;"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.\",\n \"hint\": \"Check the `client_id` parameter\",\n \"message\": \"The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.\"\n}"},{"id":"86b6987e-d2b0-41f2-af43-40d0cdfca811","name":"invalid-credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{api_client_id}}\",\n \"client_secret\": \"some-invalid-secret\",\n \"scope\": \"external\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/api/v2/oauth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Aug 2023 18:42:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' 'unsafe-inline' 'unsafe-eval' data: blob: *.sinpex.io https://www.gravatar.com/ https://cdn.datatables.net/ https://www.google.com/ https://www.gstatic.com/ https://cdn.jsdelivr.net/npm/alpinejs@3.12.0/dist/cdn.min.js https://cdn.jsdelivr.net/npm/echarts@4.9.0/dist/echarts-en.min.js https://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/pdfmake.min.js https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.1.18/vfs_fonts.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.js https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/jsoneditor.min.css https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/9.9.0/img/jsoneditor-icons.svg;"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"Client authentication failed\",\n \"message\": \"Client authentication failed\"\n}"}],"_postman_id":"4850297b-af57-42f3-bed5-15f0a96ad86e"}],"id":"d1b6bd0e-7cdb-41c3-931d-9456db5ae46b","_postman_id":"d1b6bd0e-7cdb-41c3-931d-9456db5ae46b","description":""},{"name":"Documents","item":[{"name":"Download all Case Documents (zip)","id":"a9267605-b5b2-4450-a5de-de6bc8613029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{api_token}}"}],"url":"{{domain}}/api/v2/cases/{{case_id}}/documents","description":"This endpoint provides a compressed file (.zip file) with all of the documents that were attached to the Case.
\nNo Documents
\nWhen no documents are linked to the Case, a 204 HTTP response will be sent (see success-no-documents example).
Naming Conventions
\nCurrently no naming conventions are applied to the file names.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"306099b9-3b95-479c-bfd7-1abf1eeeb800","id":"306099b9-3b95-479c-bfd7-1abf1eeeb800","name":"Documents","type":"folder"}},"urlObject":{"path":["api","v2","cases","{{case_id}}","documents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"882a1a72-8d78-439e-aa5d-f3ae232e04ec","name":"success-no-documents","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{api_token}}"}],"url":"{{domain}}/api/v2/cases/{{case_id}}/documents"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 27 Nov 2023 13:47:17 GMT"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a9267605-b5b2-4450-a5de-de6bc8613029"}],"id":"306099b9-3b95-479c-bfd7-1abf1eeeb800","description":"\n{\n \"file\": \"required|mimes:pdf,jpg,jpeg,png,tiff,tif|max:250MB|file\",\n \"type\": \"required|in:idv,other\",\n \"context\": \"nullable|object\"\n}\n\nThe idv document type refers to \"identification & verificiation\", which is commonly known as ID&V.
Uploading identification documents for specific people can be done via \"IDV Profiles\".
\nAdditional validation rules
\nWhen providing a reference to an IDV profile, please ensure that it is linked to the provided {{case_id}} and that it's state is either in_progress or verified.
When type has been specified as IDV either context.idv_profile_id or context.idv_profile_external_id is required.
These documents can be found in the IDV tab in the Sinpex UI.
\nThe other document type can be used to upload general documents for a specific Case. These documents will be visible in the Documents tab in the sinpex UI, and will also be part of the documents present in the Case report.
Includes
\nThe includes query param allows for extra related resources to be included in the response.
Currently supported values are answers, questionnaire_responses, self_declared_values, idv_profiles and risk_profiles.
For a full example see success-with-includes in the drop down of the request preview.
Confirmed
\nThe confirmed=true query parameter allows the creation of duplicate cases. If you still see the duplicate case validation error, contact our support to enable \"Allow duplicate cases\" setting for your desired project. For new projects this setting is enabled by default.
Validation Rules
\n\n\nFor more info, see our Validation Rules section.
\n
This is a quick overview of some of the general validation rules:
\n{\n \"project_id\": \"required|exists:projects,id\",\n \"company.name\": \"required|string|min:2|max:1024\",\n \"company.country_code\": \"required|alpha|min:2|max:2\",\n \"company.registration_number\": \"sometimes|nullable|string|min:2|max:64\",\n \"tags\": \"nullable|array\",\n \"tags.*\": \"string|min:2|max:16\",\n \"questionnaire_responses\": \"nullable|array\",\n \"questionnaire_responses.*.alias\": \"required|string\",\n \"questionnaire_responses.*.self_declaration\": \"nullable|object\", // More validation rules below\n \"questionnaire_responses.*.risk_profile\": \"nullable|object\", // More validation rules below\n}\n\nProject-specific Validation Rules
\nAside from these basic validation rules, there is also a couple of other implicit rules in place, which will be explained below.
\nWe also introduced a JSON schema endpoint to illustrate the expected format for specific Projects, as the Questionnaire can also impact the structure of the request body.
\nAvoiding or allowing Duplicate Cases
\nThere is a \"duplicate Case\" validation rule in place, to prevent creating the same Case in the same Project scope and triggering unneccessary document purchases.
\nThis validation rule needs to be enabled in the Admin Panel (contact support if you don't have access) on the Project level by enabling \"Allow duplicate cases\" setting, and the confirmed query parameter needs to be set to true on the API request (see Optional Query Parameters above).
For Cases in the same Project and country context (project_id and company.country_code) the name and registration number ( company.name and company.registration_number) must be unique when provided.
The example response invalid-duplicate-case in this collection shows what the response will look like.
Questionnaire Responses
\nThe format of the questionnaire_responses is closely related to the Questions definition (for more info see Resource Overview) and the agreed upon alias during the TOM workshop.
Self-Declaration
\nPlease contact Sinpex support if you would like an applicable example of what your self_declaration structure of the questionnaire_responses should look like.
However, there are already a few examples included (e.g. success-with-self-declaration ) that could get you started.
Risk Profiles
\nThe optional risk_profile attribute of the questionnaire_responses should follow this format:
{\n \"type\": \"required|string|in:person,organization\",\n \"provider_id\": \"required|string|min:2|max:64\",\n \"provider_name\": \"required|string|in:COMPLY_ADVANTAGE\",\n \"name\": \"required_if:risk_profile.type,organization|string|min:2|max:64\",\n \"first_name\": \"required_if:risk_profile.type,person|string|min:2|max:64\",\n \"middle_name\": \"sometimes|nullable|string|min:2|max:64\",\n \"last_name\": \"required_if:risk_profile.type,person|string|min:2|max:64\",\n \"risk_levels\": \"required|object|keys_in:pep,sanction,warning,adverse_media\",\n \"risk_levels.*\": \"required|string|in:low,medium,high\"\n}\n\nProviding these resources will result in risk_profiles that are linked to the Case and can be optionally included in the response too with the includes query parameter.
IDV Profile Checks
\nThe optional idv_profile_check attribute of the questionnaire_responses should follow this format:
{\n \"provider\": \"required|string|in:IDNOW\",\n \"response\": \"required|valid_id_provider_response\"\n}\n\nWhere the response format is depending on the provider. Currently, only IDNOW is supported and the format can be found on their official documention.
\nProviding these resources will result in idv_profiles that are linked to the Case and can be optionally included in the response too with the includes query parameter.
Optional Query Parameters
\nIncludes
\nThe includes query param allows for extra related resources to be included in the response.
Currently supported values are answers, questionnaire_responses , self_declared_values, idv_profiles and risk_profiles.
For a full example see success-with-includes in the drop down of the request preview.
\n\nNote: This documentation section is still under development, please reach out to Sinpex support for further questions
\n
Validation Rules
\n\n\nFor more info, see our Validation Rules section.
\n
This is a quick overview of some of the general validation rules:
\n{\n \"workflow_state_name\": \"nullable|string|in:{{project_workflow_state_names}}\",\n \"questionnaire_responses\": \"nullable|array\",\n \"questionnaire_responses.*\": {\n \"alias\" : \"required|in:{{question_template_aliases}}\",\n \"answer\" : \"missing_with:self_declaration,self_declared_value_id,answer_id\",\n \"answer_id\" : \"missing_with:self_declaration,self_declared_value_id,answer|exists:answers,id\",\n \"self_declaration\" : \"missing_with:answer,answer_id|required_with:reference_self_declared_value_id\",\n \"self_declared_value_id\" : \"missing_with:answer,answer_id,external_id|exists:self_declared_values,id\",\n \"external_id\" : \"missing_with:answer,answer_id,self_declared_value_id\",\n \"reference_self_declared_value_id\" : \"missing_with:answer,answer_id\"\n }\n}\n\nPartial Update Approach
\nAs following the REST principles, when a top-level attribute is not included in the PATCH request, the omitted attributes will not be touched. Only the ones present in the request will be affected.
Questionnaire Responses Scenarios
\nTo make changes to the current Answers and Self-Declared Values of a Case, the questionnaire_responses attribute can be used.
\n\nNote: Updating IDV and Risk profiles via the Public API v2 is currently not supported
\n
The approach is similar to the questionnaire_responses of the Create Case endpoint, but with some important differences.
Questionnaire Responses Update Approach
\nOnly the resources of the Questions for which the alias is provided in the questionnaire_responses will be affected. When a Question is not referenced, the related resources (Answers, Self-Declared Values, Risk Profiles, etc.) will not be touched.
When a Question alias is referenced, the complete representation of the state for that Question must be included in the request body.
\n\nNote: To get the current
\nquestionnaire_responsesstatus of the case, see the Get Case documentation, using theincludesquery parameter.
Modifying Answers
\n1. Keeping an Answer as is
\n{\n \"alias\" : \"some-alias\",\n \"answer_id\" : \"{{answer_id}}\",\n}\n\n2. Creating a new Answer
\n{\n \"alias\" : \"some-alias\",\n \"answer\" : \"some new Answer content\",\n}\n\nModifying Self-Declared Values
\n1. Keeping a Self-Declared Value as is
\n{\n \"alias\" : \"some-alias\",\n \"self_declared_value_id\" : \"{{self_declared_value_id}}\"\n}\n\n2. Keeping a Self-Declared Value as is, via an existing external id
\n{\n \"alias\" : \"some-alias\",\n \"external_id\" : \"{{external_id}}\"\n}\n\n3. Creating a new Self-Declared Value
\n{\n \"alias\" : \"some-alias\",\n \"self_declaration\" : \"Some updated Self-Declared Value content\"\n}\n\n4. Creating a new Self-Declared Value, keeping the related resources of an old Self-Declared value
\n{\n \"alias\" : \"some-alias\",\n \"self_declaration\" : \"Some updated Self-Declared Value content\",\n \"reference_self_declared_value_id\" : \"{{self_declared_value_id}}\"\n}\n\n5. Creating a new Self-Declared Value, keeping the related resources of an old Self-Declared value, via an existing external id
\n{\n \"alias\" : \"some-alias\",\n \"self_declaration\" : \"Some updated Self-Declared Value content\",\n \"external_id\" : \"{{external_id}}\"\n}\n\nThis section will help you set up and configure webhooks, enabling real-time event notifications.
\nTo configure webhooks, navigate to your admin dashboard settings. In this section, you can specify the webhook v2 URL and define authorization header information to ensure secure communication.
\nIn the examples below, the configured URL will be referenced by {{webhookUrl}}.
This webhook is triggered when there is a change in the workflow state of a case. When this event occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"WORKFLOW_STATE_CHANGED\",\n \"occurred_at\": \"2023-12-31T12:55:55Z\",\n \"context\": {\n \"case_id\" : 123,\n \"previous\": \"{{previous_workflow_state_name}}\", \n \"current\": \"{{current_workflow_state_name}}\"\n }\n}\n\nThe values for previous and current are the names of the Worflow States.
This webhook is triggered when an error occurs in the rule automation of a workflow state within a case. When this event takes place, the system sends a webhook with a JSON payload in the following format:
\n{\n \"event\": \"WORKFLOW_AUTOMATION_STOPPED\",\n \"error_code\": \"{{error_code}}\",\n \"occurred_at\": \"2024-09-19T10:59:31+02:00\",\n \"context\": {\n \"case_id\": 123,\n \"current_workflow_state\": \"{{current_workflow_state_name}}\",\n \"failed_rules\": [\n \"{{failed_rule_1}}\",\n \"{{failed_rule_2}}\"\n ]\n }\n}\n\n{{error_code}}: describes the specific error encountered, which can be one of the following: AUTOMATION_RULE_FAILED
{{current_workflow_state_name}}: is the name of the case's current Worflow State.
\n{{failed_rule_1}} or {{failed_rule_2}}: the name of the rules that failed, see Workflow Automation Rules for the complete list of possibilites here
\nThis webhook is triggered when there is a failure related to a document, which can occur when a company or document is not found, document OCR fails, or other similar issues. When this event occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"DOCUMENT_FAILURE\",\n \"error_code\": \"{{error_code}}\",\n \"occurred_at\": \"2023-12-31T12:55:55Z\",\n \"context\": {\n \"case_id\": 123,\n \"document_type\": \"{{document_type}}\",\n \"document_description\": \"Some description (e.g. Company Registry (backup)) or file name\"\n }\n}\n\n{{error_code}}: describes the specific error encountered, which can be one of the following: COMPANY_NOT_FOUND, DOCUMENT_NOT_AVAILABLE, DOCUMENT_OCR_FAILED.
{{document_type}}: possible values COMMERCIAL_REGISTER, TRANSPARENCY_REGISTER`, SHARE_HOLDER_LIST, CREDIT_CHECK, IDV, OTHER
This webhook is triggered when there is an analytic failure, specifically when the analytics engine cannot find an answer for specific questions. When this event occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"ANALYTIC_FAILURE\",\n \"error_code\": \"{{error_code}}\",\n \"occurred_at\": \"2023-12-31T12:55:55Z\",\n \"context\": {\n \"case_id\": 123,\n \"questions\": [\n {\n \"question_id\": 12,\n \"alias\": \"general.full_legal_name\",\n \"label\": \"Full legal company name\"\n },\n {\n \"question_id\": 14,\n \"alias\": \"general.tax_id\",\n \"label\": \"Tax ID\"\n }\n ]\n }\n}\n\nANSWERS_NOT_FOUND.This webhook is triggered when an identification and verification (ID&V) check is not successful. When this event occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"IDENTIFICATION_FAILURE\",\n \"error_code\": \"{{error_code}}\",\n \"context\": {\n \"case_id\": 123,\n \"idv_profile_id\": 321\n }\n}\n\nPERSONAL_DATA_MISMATCH.This webhook is triggered when the system detects a change in the health status of one or more third-party providers. When this event occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"HEALTH_CHECK_UPDATE\",\n \"context\": {\n \"services\": [\"COMMERCIAL_REGISTER\", \"TRANSPARENCY_REGISTER\"],\n \"status\": \"DEGRADED\",\n \"country_code\": \"DE\"\n }\n}\n\nservices: Indicates which services are affected, currently supported values: COMMERCIAL_REGISTER, TRANSPARENCY_REGISTER
status: Supported values: OFFLINE, DEGRADED, HEALTHY, or UNKNOWN
country_code: The ISO 3166-1 alpha-2 code of the country or region that is affected
\nThe webhook is triggered in cases when system detects a mismatch of answers and self declared values. There are two different cases when this webhook occurs.
\nThis occurs when there is a mismatch of number of answers and self declared answers for a question.
\n{\n \"event\": \"SELF_DECLARATION_FAILURE\",\n \"error_code\": \"INVALID_COUNT\",\n \"context\": {\n \"case_id\": 123,\n \"invalid_entries\": [\n {\n \"question_id\": 24,\n \"question_alias\": \"ubo\",\n \"question_label\": \"UBO\",\n \"number_of_answers_expected\": 2, \n \"number_of_answers_received\": 1 \n },\n {\n \"question_id\": 24,\n \"question_alias\": \"signatory\",\n \"question_label\": \"Signatory\",\n \"number_of_answers_expected\": 1,\n \"number_of_answers_received\": 2 \n },\n ]\n }\n}\n\nThis occurs when value of answer and self declared answer are not passing the equality threshold.
\n{\n \"event\": \"SELF_DECLARATION_FAILURE\",\n \"error_code\": \"INVALID_VALUES\",\n \"context\": {\n \"case_id\": 123,\n \"invalid_entries\": [\n {\n \"question_id\": 12,\n \"question_alias\": \"general.full_legal_name\",\n \"question_label\": \"Full legal name\",\n \"answer_expected\": \"Heineken\",\n \"answer_received\": \"Augustiner GmbH\"\n },\n {\n \"question_id\": 23,\n \"question_alias\": \"general.street\",\n \"question_label\": \"Street\",\n \"answer_expected\": \"Mustermannstr.\",\n \"answer_received\": \"Maximilianstr.\"\n },\n {\n \"question_id\": 23,\n \"question_alias\": \"ubo.first_name\",\n \"question_label\": \"First Name\",\n \"answer_expected\": \"Correct/From document\",\n \"answer_received\": \"Incorrect/From Self Declaration\"\n }\n ]\n }\n}\n\nThis occurs when value of self declared answer and IDV profile are not passing the equality threshold.
\n{\n \"event\": \"SELF_DECLARATION_FAILURE\",\n \"error_code\": \"IDV_PROFILE_MISMATCH\",\n \"context\": {\n \"case_id\": 123,\n \"invalid_entries\": [\n {\n \"question_id\": 23,\n \"question_alias\": \"ubo\",\n \"question_label\": \"UBO\",\n \"received_self_declaration\": {{self_declared_structure}},\n \"expected_idv_profile\": null\n },\n {\n \"question_id\": 23,\n \"question_alias\": \"ubo\",\n \"question_label\": \"UBO\",\n \"received_self_declaration\": {{self_declared_structure}},\n \"expected_idv_profile\": {\n \"id\": 2,\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n }\n },\n {\n \"question_id\": 23,\n \"question_alias\": \"ubo\",\n \"question_label\": \"UBO\",\n \"received_self_declaration\": {{self_declared_structure}},\n \"expected_idv_profile\": {\n \"id\": 3,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n ]\n }\n}\n\nThis webhook is triggered when a new Notification got created. These are the same as the ones visible in Sinpex UI at the Case notification bell. When a Notification like that occurs, the system will send a webhook with a JSON payload in the following format:
\n{\n \"event\": \"NOTIFICATION_CREATED\",\n \"occurred_at\": \"2025-05-16T10:55:55Z\",\n \"context\": {\n \"notification_id\": 11,\n \"case_id\" : 123,\n \"type\": \"INFO\",\n \"message\": \"{{notification_text}}\"\n }\n}\n\nnotification_id: the id of the notification, useful for debugging
\ncase_id: the id of the Case or null
type: one of INFO, SUCCESS, ERROR
message: The text contents of the Notification
\n\n\nFor more information about JSON Schema, check out it's website
\n
This endpoint provides a JSON schema for creating a Case through the API (see Create Case request), offering a structured blueprint to facilitate seamless case creation. Developers can leverage this resource to ensure accurate and efficient data submission in line with the system requirements.
\n","urlObject":{"path":["api","v2","projects","{{project_id}}","json-schema"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"53bbfb66-62f7-47b6-a7fe-83f519dc5599","name":"success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{api_token}}"}],"url":"{{domain}}/api/v2/projects/{{project_id}}/json-schema"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 02 Jan 2024 15:23:46 GMT"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"1914"}],"cookie":[],"responseTime":null,"body":"{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\"\n },\n \"company\": {\n \"$ref\": \"#/$defs/_company\"\n },\n \"meta\": {\n \"nullable\": true\n },\n \"webhook_url\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"tags\": {\n \"nullable\": true,\n \"type\": \"array\",\n \"items\": {\n \"minLength\": 2,\n \"maxLength\": 16,\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"project_id\",\n \"company\"\n ],\n \"$defs\": {\n \"_company\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"minLength\": 2,\n \"maxLength\": 1024,\n \"type\": \"string\"\n },\n \"registration_number\": {\n \"nullable\": true,\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"minLength\": 2,\n \"maxLength\": 2,\n \"enum\": [\n \"AF\",\n \"AX\",\n \"AL\",\n \"DZ\",\n \"AS\",\n \"AD\",\n \"AO\",\n \"AI\",\n \"AQ\",\n \"AG\",\n \"AR\",\n \"AM\",\n \"AW\",\n \"AU\",\n \"AT\",\n \"AZ\",\n \"BH\",\n \"BS\",\n \"BD\",\n \"BB\",\n \"BY\",\n \"BE\",\n \"BZ\",\n \"BJ\",\n \"BM\",\n \"BT\",\n \"BO\",\n \"BQ\",\n \"BA\",\n \"BW\",\n \"BV\",\n \"BR\",\n \"IO\",\n \"BN\",\n \"BG\",\n \"BF\",\n \"BI\",\n \"KH\",\n \"CM\",\n \"CA\",\n \"CV\",\n \"KY\",\n \"CF\",\n \"TD\",\n \"CL\",\n \"CN\",\n \"CX\",\n \"CC\",\n \"CO\",\n \"KM\",\n \"CG\",\n \"CD\",\n \"CK\",\n \"CR\",\n \"CI\",\n \"HR\",\n \"CU\",\n \"CW\",\n \"CY\",\n \"CZ\",\n \"DK\",\n \"DJ\",\n \"DM\",\n \"DO\",\n \"EC\",\n \"EG\",\n \"SV\",\n \"GQ\",\n \"ER\",\n \"EE\",\n \"ET\",\n \"FK\",\n \"FO\",\n \"FJ\",\n \"FI\",\n \"FR\",\n \"GF\",\n \"PF\",\n \"TF\",\n \"GA\",\n \"GM\",\n \"GE\",\n \"DE\",\n \"GH\",\n \"GI\",\n \"GR\",\n \"GL\",\n \"GD\",\n \"GP\",\n \"GU\",\n \"GT\",\n \"GG\",\n \"GN\",\n \"GW\",\n \"GY\",\n \"HT\",\n \"HM\",\n \"VA\",\n \"HN\",\n \"HK\",\n \"HU\",\n \"IS\",\n \"IN\",\n \"ID\",\n \"IR\",\n \"IQ\",\n \"IE\",\n \"IM\",\n \"IL\",\n \"IT\",\n \"JM\",\n \"JP\",\n \"JE\",\n \"JO\",\n \"KZ\",\n \"KE\",\n \"KI\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KG\",\n \"LA\",\n \"LV\",\n \"LB\",\n \"LS\",\n \"LR\",\n \"LY\",\n \"LI\",\n \"LT\",\n \"LU\",\n \"MO\",\n \"MK\",\n \"MG\",\n \"MW\",\n \"MY\",\n \"MV\",\n \"ML\",\n \"MT\",\n \"MH\",\n \"MQ\",\n \"MR\",\n \"MU\",\n \"YT\",\n \"MX\",\n \"FM\",\n \"MD\",\n \"MC\",\n \"MN\",\n \"ME\",\n \"MS\",\n \"MA\",\n \"MZ\",\n \"MM\",\n \"NA\",\n \"NR\",\n \"NP\",\n \"NL\",\n \"NC\",\n \"NZ\",\n \"NI\",\n \"NE\",\n \"NG\",\n \"NU\",\n \"NF\",\n \"MP\",\n \"NO\",\n \"OM\",\n \"PK\",\n \"PW\",\n \"PS\",\n \"PA\",\n \"PG\",\n \"PY\",\n \"PE\",\n \"PH\",\n \"PN\",\n \"PL\",\n \"PT\",\n \"PR\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RU\",\n \"RW\",\n \"BL\",\n \"SH\",\n \"KN\",\n \"LC\",\n \"MF\",\n \"PM\",\n \"VC\",\n \"WS\",\n \"SM\",\n \"ST\",\n \"SA\",\n \"SN\",\n \"RS\",\n \"SC\",\n \"SL\",\n \"SG\",\n \"SX\",\n \"SK\",\n \"SI\",\n \"SB\",\n \"SO\",\n \"ZA\",\n \"GS\",\n \"SS\",\n \"ES\",\n \"LK\",\n \"SD\",\n \"SR\",\n \"SJ\",\n \"SZ\",\n \"SE\",\n \"CH\",\n \"SY\",\n \"TW\",\n \"TJ\",\n \"TZ\",\n \"TH\",\n \"TL\",\n \"TG\",\n \"TK\",\n \"TO\",\n \"TT\",\n \"TN\",\n \"TR\",\n \"TM\",\n \"TC\",\n \"TV\",\n \"UG\",\n \"UA\",\n \"AE\",\n \"GB\",\n \"US\",\n \"UM\",\n \"UY\",\n \"UZ\",\n \"VU\",\n \"VE\",\n \"VN\",\n \"VG\",\n \"VI\",\n \"WF\",\n \"EH\",\n \"YE\",\n \"ZM\",\n \"ZW\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"country_code\"\n ]\n }\n }\n}"},{"id":"dfb2e309-e291-417d-8122-658afebe5072","name":"success-complex","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{api_token}}"}],"url":"{{domain}}/api/v2/projects/{{project_id}}/json-schema"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 02 Jan 2024 15:27:47 GMT"},{"key":"Vary","value":"Origin"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"project_id\": {\n \"type\": \"string\"\n },\n \"company\": {\n \"$ref\": \"#/$defs/_company\"\n },\n \"meta\": {\n \"nullable\": true\n },\n \"webhook_url\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"tags\": {\n \"nullable\": true,\n \"type\": \"array\",\n \"items\": {\n \"minLength\": 2,\n \"maxLength\": 16,\n \"type\": \"string\"\n }\n },\n \"questionnaire_responses\": {\n \"nullable\": true,\n \"type\": \"array\",\n \"items\": {\n \"properties\": {\n \"alias\": {\n \"enum\": [\n \"general.full_legal_name\",\n \"general.legal_form\",\n \"general.registry_number\",\n \"general.full_registered_address\",\n \"general.vat\",\n \"general.industry_sector\",\n \"general.business_purpose\",\n \"signatory\",\n \"ubo\",\n \"bo\",\n \"risk_screening.risk_class\",\n \"risk_screening.aml_results\"\n ],\n \"type\": \"string\"\n },\n \"answer\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/$defs/answer.risk_screening.risk_class\"\n },\n {\n \"$ref\": \"#/$defs/answer.risk_screening.aml_results\"\n }\n ]\n },\n \"self_declaration\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/$defs/self_declaration.general.full_legal_name\"\n },\n {\n \"$ref\": \"#/$defs/self_declaration.general.registry_number\"\n },\n {\n \"$ref\": \"#/$defs/self_declaration.signatory\"\n },\n {\n \"$ref\": \"#/$defs/self_declaration.ubo\"\n },\n {\n \"$ref\": \"#/$defs/self_declaration.bo\"\n }\n ]\n },\n \"risk_profile\": {\n \"$ref\": \"#/$defs/_risk_profile\"\n },\n \"idv_profile_check\": {\n \"$ref\": \"#/$defs/_idv_profile_check\"\n }\n }\n }\n }\n },\n \"required\": [\n \"project_id\",\n \"company\"\n ],\n \"$defs\": {\n \"_company\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"minLength\": 2,\n \"maxLength\": 1024,\n \"type\": \"string\"\n },\n \"registration_number\": {\n \"nullable\": true,\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"country_code\": {\n \"minLength\": 2,\n \"maxLength\": 2,\n \"enum\": [\n \"AF\",\n \"AX\",\n \"AL\",\n \"DZ\",\n \"AS\",\n \"AD\",\n \"AO\",\n \"AI\",\n \"AQ\",\n \"AG\",\n \"AR\",\n \"AM\",\n \"AW\",\n \"AU\",\n \"AT\",\n \"AZ\",\n \"BH\",\n \"BS\",\n \"BD\",\n \"BB\",\n \"BY\",\n \"BE\",\n \"BZ\",\n \"BJ\",\n \"BM\",\n \"BT\",\n \"BO\",\n \"BQ\",\n \"BA\",\n \"BW\",\n \"BV\",\n \"BR\",\n \"IO\",\n \"BN\",\n \"BG\",\n \"BF\",\n \"BI\",\n \"KH\",\n \"CM\",\n \"CA\",\n \"CV\",\n \"KY\",\n \"CF\",\n \"TD\",\n \"CL\",\n \"CN\",\n \"CX\",\n \"CC\",\n \"CO\",\n \"KM\",\n \"CG\",\n \"CD\",\n \"CK\",\n \"CR\",\n \"CI\",\n \"HR\",\n \"CU\",\n \"CW\",\n \"CY\",\n \"CZ\",\n \"DK\",\n \"DJ\",\n \"DM\",\n \"DO\",\n \"EC\",\n \"EG\",\n \"SV\",\n \"GQ\",\n \"ER\",\n \"EE\",\n \"ET\",\n \"FK\",\n \"FO\",\n \"FJ\",\n \"FI\",\n \"FR\",\n \"GF\",\n \"PF\",\n \"TF\",\n \"GA\",\n \"GM\",\n \"GE\",\n \"DE\",\n \"GH\",\n \"GI\",\n \"GR\",\n \"GL\",\n \"GD\",\n \"GP\",\n \"GU\",\n \"GT\",\n \"GG\",\n \"GN\",\n \"GW\",\n \"GY\",\n \"HT\",\n \"HM\",\n \"VA\",\n \"HN\",\n \"HK\",\n \"HU\",\n \"IS\",\n \"IN\",\n \"ID\",\n \"IR\",\n \"IQ\",\n \"IE\",\n \"IM\",\n \"IL\",\n \"IT\",\n \"JM\",\n \"JP\",\n \"JE\",\n \"JO\",\n \"KZ\",\n \"KE\",\n \"KI\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KG\",\n \"LA\",\n \"LV\",\n \"LB\",\n \"LS\",\n \"LR\",\n \"LY\",\n \"LI\",\n \"LT\",\n \"LU\",\n \"MO\",\n \"MK\",\n \"MG\",\n \"MW\",\n \"MY\",\n \"MV\",\n \"ML\",\n \"MT\",\n \"MH\",\n \"MQ\",\n \"MR\",\n \"MU\",\n \"YT\",\n \"MX\",\n \"FM\",\n \"MD\",\n \"MC\",\n \"MN\",\n \"ME\",\n \"MS\",\n \"MA\",\n \"MZ\",\n \"MM\",\n \"NA\",\n \"NR\",\n \"NP\",\n \"NL\",\n \"NC\",\n \"NZ\",\n \"NI\",\n \"NE\",\n \"NG\",\n \"NU\",\n \"NF\",\n \"MP\",\n \"NO\",\n \"OM\",\n \"PK\",\n \"PW\",\n \"PS\",\n \"PA\",\n \"PG\",\n \"PY\",\n \"PE\",\n \"PH\",\n \"PN\",\n \"PL\",\n \"PT\",\n \"PR\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RU\",\n \"RW\",\n \"BL\",\n \"SH\",\n \"KN\",\n \"LC\",\n \"MF\",\n \"PM\",\n \"VC\",\n \"WS\",\n \"SM\",\n \"ST\",\n \"SA\",\n \"SN\",\n \"RS\",\n \"SC\",\n \"SL\",\n \"SG\",\n \"SX\",\n \"SK\",\n \"SI\",\n \"SB\",\n \"SO\",\n \"ZA\",\n \"GS\",\n \"SS\",\n \"ES\",\n \"LK\",\n \"SD\",\n \"SR\",\n \"SJ\",\n \"SZ\",\n \"SE\",\n \"CH\",\n \"SY\",\n \"TW\",\n \"TJ\",\n \"TZ\",\n \"TH\",\n \"TL\",\n \"TG\",\n \"TK\",\n \"TO\",\n \"TT\",\n \"TN\",\n \"TR\",\n \"TM\",\n \"TC\",\n \"TV\",\n \"UG\",\n \"UA\",\n \"AE\",\n \"GB\",\n \"US\",\n \"UM\",\n \"UY\",\n \"UZ\",\n \"VU\",\n \"VE\",\n \"VN\",\n \"VG\",\n \"VI\",\n \"WF\",\n \"EH\",\n \"YE\",\n \"ZM\",\n \"ZW\"\n ],\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"country_code\"\n ]\n },\n \"self_declaration.general.full_legal_name\": {\n \"type\": \"string\"\n },\n \"self_declaration.general.registry_number\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"self_declaration.signatory\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"enum\": [\n \"company\",\n \"person\"\n ],\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"middle_name\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"date_of_birth\": {\n \"type\": \"string\"\n },\n \"place_of_birth\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"residence_address\": {\n \"type\": \"string\"\n },\n \"nationalities\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_id\": {\n \"nullable\": true,\n \"type\": \"string\"\n }\n }\n },\n \"self_declaration.ubo\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"enum\": [\n \"company\",\n \"person\"\n ],\n \"type\": \"string\"\n },\n \"percentage\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"middle_name\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"date_of_birth\": {\n \"type\": \"string\"\n },\n \"place_of_birth\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"residence_address\": {\n \"type\": \"string\"\n },\n \"nationalities\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_id\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"fictional_ubo\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n }\n }\n },\n \"self_declaration.bo\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"enum\": [\n \"company\",\n \"person\"\n ],\n \"type\": \"string\"\n },\n \"percentage\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"middle_name\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"date_of_birth\": {\n \"type\": \"string\"\n },\n \"place_of_birth\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"residence_address\": {\n \"type\": \"string\"\n },\n \"nationalities\": {\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"external_id\": {\n \"nullable\": true,\n \"type\": \"string\"\n }\n }\n },\n \"answer.risk_screening.risk_class\": {\n \"enum\": [\n \"low\",\n \"medium\",\n \"high\"\n ],\n \"type\": \"string\"\n },\n \"answer.risk_screening.aml_results\": {\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"enum\": [\n \"company\",\n \"person\"\n ],\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"pep\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"sanction\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"adverse_media\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"warnings\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"fitness\": {\n \"nullable\": true,\n \"type\": \"boolean\"\n },\n \"risk_class\": {\n \"nullable\": true,\n \"enum\": [\n \"low\",\n \"medium\",\n \"high\"\n ]\n }\n }\n },\n \"_risk_profile\": {\n \"type\": \"object\",\n \"properties\": {\n \"risk_profile\": {\n \"type\": \"array\"\n },\n \"type\": {\n \"enum\": [\n \"person\",\n \"organization\",\n \"custom\"\n ],\n \"type\": \"string\"\n },\n \"provider_id\": {\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"provider_name\": {\n \"enum\": [\n \"COMPLY_ADVANTAGE\"\n ],\n \"type\": \"string\"\n },\n \"name\": {\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"first_name\": {\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"middle_name\": {\n \"nullable\": true,\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"last_name\": {\n \"minLength\": 2,\n \"maxLength\": 64,\n \"type\": \"string\"\n },\n \"risk_levels\": {\n \"type\": \"object\",\n \"properties\": {\n \"pep\": {\n \"$ref\": \"#/$defs/_risk_level\"\n },\n \"sanction\": {\n \"$ref\": \"#/$defs/_risk_level\"\n },\n \"warning\": {\n \"$ref\": \"#/$defs/_risk_level\"\n },\n \"adverse_media\": {\n \"$ref\": \"#/$defs/_risk_level\"\n }\n }\n }\n }\n },\n \"_risk_level\": {\n \"enum\": [\n \"low\",\n \"medium\",\n \"high\"\n ],\n \"type\": \"string\"\n },\n \"_idv_profile_check\": {\n \"type\": \"object\",\n \"properties\": {\n \"provider\": {\n \"enum\": [\n \"IDNOW\"\n ],\n \"type\": \"string\"\n },\n \"response\": {\n \"type\": \"object\"\n }\n }\n }\n }\n}"}],"_postman_id":"d2385b03-16f0-4f5b-b431-e1002a6b0498"}],"id":"13a0e9ee-f043-46d4-b406-39aa216791f1","_postman_id":"13a0e9ee-f043-46d4-b406-39aa216791f1","description":""}]}