KYB Enhanced Report API Documentation
KYB Enhanced API Documentation
Endpoint
POST `https://api.satschel.com/v2/kyb/entity
GET `https://api.satschel.com/v2/kyb/entity/:id
Overall Structure
This section provides an overview of the overall request and response structure of the KYB Enhanced API.
Request Structure
- company (object): Contains the details of the company.
- kybConfigurations (object): Specifies the KYB configuration settings.
- representatives (array): List of authorized representatives to be verified.
Response Structure
- message (string): Status message of the API call.
- data (object): Contains detailed verification results, including status, basic company info, authorized representatives, and compliance information.
Address Object
The address object includes the following fields:
- address (string): Street address of the company.
- city (string): City where the company is located.
- state (string): State where the company is located.
- zipCode (string): ZIP code of the company's location.
Person Object
The person object includes the following fields:
- first_name (string): First name of the representative.
- last_name (string): Last name of the representative.
- national_id_number (string): National ID number of the representative.
- date_of_birth (string): Date of birth of the representative in YYYYMMDD format.
- telephone_number (string): Phone number of the representative.
Sample Data (POST)
This is the sample JSON data sent in a POST request to the KYB Enhanced API to get the verification result.
{
"company": {
"companyId": "914108804",
"requestId": "66583a18d50e7b49ffba4324"
},
"configurations": {
"enhanced": true
},
"representatives": [
{
"firstName": "Test",
"lastName": "last",
"dateOfBirth": {
"year": "1942",
"month": "11",
"day": "21"
},
"nationalIdNumber": "123456789",
"telephone": "+141231111"
}
]
}
Documentation: Company Verification Output
This section describes the data structure of the output returned by the KYB API after processing a company's details.
Overall Structure
The response contains the following key elements:
- message: A string indicating the status of the request.
- data: An object containing detailed results, including company status, basic info, representatives, similar companies, and compliance details.
Api Results
The data object includes:
- status (string): The overall verification status (e.g., "rejected").
- basicInfo (object): Basic information about the company.
- similarCompanies (array): List of similar companies found during the verification.
- authorizedRepresentative (object): Verification details of the company's authorized representative.
- compliance (object): Compliance-related details.
AuthorizedRepresentativeResults
The authorizedRepresentative object includes:
- name (object): Name of the representative with verification status.
- dateOfBirth (object): Date of birth with verification status.
- phone (object): Phone number with verification status.
- nationalIdNumber (object): National ID number with verification status.
- relatesToBusiness (boolean): Indicates if the representative is related to the business.
- id (string): Unique ID for the representative.
Sample Output
The sample output of the KYB Enhanced API is shown below:
{
"message": "ok",
"data": {
"status": "rejected",
"basicInfo": {
"name": {
"value": "Company Name",
"status": "verified"
},
"status": {
"value": "active"
},
"tin": {
"value": "123456789",
"status": "verified"
},
"location": {
"value": {
"address": {
"value": "Address",
"status": "not-verified"
},
"city": {
"value": "City",
"status": "not-verified"
},
"state": {
"value": "State",
"status": "not-verified"
},
"zipCode": {
"value": "94108",
"status": "not-verified"
}
}
},
"contactDetails": {
"value": {
"phone": {
"value": [
{
"value": "Phone Number",
"status": "not-verified"
}
]
}
}
},
"errorMessages": [
"The company is not verified.",
"The representative is not verified.",
"The representative is not associated with business."
]
},
"similarCompanies": {
"value": [
{
"name": {
"value": "Company Name"
},
"address": {
"value": "Address"
}
},
{
"name": {
"value": "Company Name"
},
"address": {
"value": "Address"
}
},
{
"name": {
"value": "Company Name"
},
"address": {
"value": "Address"
}
}
]
},
"authorizedRepresentative": {
"value": [
{
"name": {
"value": "First Name",
"status": "not-verified"
},
"dateOfBirth": {
"value": "YYYYMMDD",
"status": "not-verified"
},
"phone": {
"value": "Phone Number",
"status": "not-verified"
},
"nationalIdNumber": {
"value": "XXXXX6789",
"status": "not-verified"
},
"relatesToBusiness": {
"value": false},
"id": {
"value": "id"
}
}
]
},
"compliance": {
"TimeOnSOS": {
"value": "0"
},
"SOSStatus": {
"value": "UNKNOWN"
},
"LNStatus": {
"value": "NO RECENT PUBLIC RECORDS"
},
"TimeOnPublicRecord": {
"value": "116"
},
"County": {
"value": "Country"
},
"BusinessFirstSeenYYYY": {
"value": "2014"
}
}
}
}
User Flow
- User Enters Business Details
- The user initiates the process by entering the following business details:
- Business Name
- FEIN (Federal Employer Identification Number)
- Country
- State
- The user initiates the process by entering the following business details:
- Business Search API Call
- The system makes a call to the Business Search API using the provided business details.
- Fetch Business List from LexisNexis
- The Business Search API retrieves a list of businesses matching the entered details from the LexisNexis database.
- User Selects Business or Enters Manually
- The user either selects a business from the fetched list or manually enters the business details if their business is not listed.
- User Enters Authorized Representative Details
- The user then provides details of the authorized representative, including:
- First Name
- Last Name
- Date of Birth
- SSN (Social Security Number)
- Phone Number
- The user then provides details of the authorized representative, including:
- User Clicks on Submit
- Upon completing the form with the necessary details, the user clicks the submit button to proceed.
Sample KYB Enhanced API Post Request
The following JSON sample illustrates the structure of the POST request sent to the KYB Enhanced API:
{
"company": {
"companyId": "Company ID from the search request",
"requestId": "Request ID from the search request"
},
"kybConfigurations": {
"kyb_enhanced": true,
"kyb_comprehensive": false},
"representatives": [
{
"first_name": "First Name",
"last_name": "Last Name",
"national_id_number": "SSN",
"date_of_birth": "YYYYMMDD",
"telephone_number": "Phone Number"
}
]
}
Sample KYB Enhanced API Response
The following JSON sample demonstrates the structure of the response received from the KYB Enhanced API:
{
"message": "ok",
"data": {
"status": "rejected",
"basicInfo": {
"name": {
"value": "Company Name",
"status": "verified"
},
"status": {
"value": "active"
},
"tin": {
"value": "123456789",
"status": "verified"
},
"location": {
"value": {
"address": {
"value": "237 KEARNY ST",
"status": "not-verified"
},
"city": {
"value": "City",
"status": "not-verified"
},
"state": {
"value": "State",
"status": "not-verified"
},
"zipCode": {
"value": "94108",
"status": "not-verified"
}
}
},
"contactDetails": {
"value": {
"phone
Updated 11 months ago