PomeloEx.
View Source
Know Your Business (KYB) identity verification for legal entities.
Manages identity validation sessions for companies and their representatives. Supports document upload, additional session creation for employees, and report generation.
Flow
create_session/1— Start a new KYB validation session for a legal entitycreate_session_additional/1— Add natural persons (employees) to the sessionupload_file/1— Upload company and identity documentsget_session/1— Check session statusobtaining_session_report/1— Retrieve validated company data
Summary
Functions
Cancel Session The identity/v1/sessions/{session_id} endpoint lets you cancel an identity validation session.
Create session The identity/v2/sessions endpoint allows you to create a new identity validation session for Legal Entities, based on one of our validation flows, and returns a unique identifier for it.
Create session - Additional The identity/v2/sessions endpoint allows you to create a new identity validation session for natural persons (employee), associated with the Company which was previously validated.
Get session The identity/v1/session/{session_id} endpoint lets you get data from an identity validation session.
Obtaining a Session Report The identity/v1/sessions/{session_id}/report endpoint lets you obtain the data collected from company in an identity validation session.
Search session The /sessions endpoint allow you to perform a search with specific filters.
Upload File The identity/v1/sessions/{session_id}/entities/{user_id or company_id}/files/{type_document} endpoint will be used with the “Session Creation” ones. The purpose is to be able to upload the supporting documents that are needed depending on each type of session.
Functions
Cancel Session The identity/v1/sessions/{session_id} endpoint lets you cancel an identity validation session.
Create session The identity/v2/sessions endpoint allows you to create a new identity validation session for Legal Entities, based on one of our validation flows, and returns a unique identifier for it.
Create session - Additional The identity/v2/sessions endpoint allows you to create a new identity validation session for natural persons (employee), associated with the Company which was previously validated.
Get session The identity/v1/session/{session_id} endpoint lets you get data from an identity validation session.
Obtaining a Session Report The identity/v1/sessions/{session_id}/report endpoint lets you obtain the data collected from company in an identity validation session.
Search session The /sessions endpoint allow you to perform a search with specific filters.
Date range# There is a filter for the created_at field, which can be used to get sessions created within a date range. For example: filter[created_at][from]=2021-07-27&filter[created_at][to]=2021-07-28
Upload File The identity/v1/sessions/{session_id}/entities/{user_id or company_id}/files/{type_document} endpoint will be used with the “Session Creation” ones. The purpose is to be able to upload the supporting documents that are needed depending on each type of session.
The supported documents are:
For Argentina
selfie: photo of the person's face requesting session validation.
- identity-card-front: frontal photo of the identification document.
- identity-card-back: backside photo of the identification document.
- company-document: according to the Company type, different types of documentation will be required.
For Brazil
selfie: photo of the person's face requesting session validation.
- identity-card-front: frontal photo of the identification document.
- identity-card-back: backside photo of the identification document.
- driver-license-front: frontal photo of the driver's license.
- driver-license-back: backside photo of the driver's license.
- company-document: Articles of incorporation, statute, subscription bulletin, Articles of incorporation with sworn translation or updated document with a registration that proves the constitution of the company.