KYB Search API Documentation

Overview

The KYB Search API provides a solution for searching companies using fuzzy logic and providing a list of companies. This documentation covers the API's endpoints, structure, data objects, and sample data for both requests and responses.

Endpoint

POST `https://api.satschel.com/v2/kyb/entity-search

GET `https://api.satschel.com/v2/kyb/entity-search/:id

Overall Structure

Address Object

{
    "street": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
}

Person Object

{
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "string (YYYY-MM-DD)",
    "address": {
        "street": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
    },
    "phone": "string",
    "email": "string"
}

Sample Data (POST): Request Payload

This section describes the sample data to be sent as a POST request to initiate a company verification.

KYB Search Create API: Sample Data (POST)

{
    "companyName": "Company Name",
    "state": "State",
    "country": "Country",
    "tin": "915555703"
}

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

{
    "message": "string",
    "data": {
        "status": "string",
        "companies": [
            {
                "id": "string",
                "name": "string",
                "address": "string",
                "isActive": "boolean",
                "phone": "string",
                "tin": "string"
            }
        ],
        "_id": "string"
    }
}

API Results

• message: A string indicating the status of the API call.
• data: An object containing the result details.
  • status: A string indicating the status of the verification (e.g., "completed").
  • companies: An array of company objects.
    • id: A string representing the company's ID.
    • name: A string representing the company's name.
    • address: A string representing the company's address.
    • isActive: A boolean indicating whether the company is active.
    • phone: A string representing the company's phone number.
    • tin: A string representing the company's Tax Identification Number (TIN).
  • _id: A string representing the unique identifier of the API call.

AuthorizedRepresentativeResults

Not applicable for the current sample data and response structure.

Sample Output

This section provides a sample of the output returned by the KYB API for the given input.

KYB Search Response

{
    "message": "ok",
    "data": {
        "status": "completed",
        "companies": [
            {
                "id": "id",
                "name": "Company Name",
                "address": "Address",
                "isActive": true,
                "phone": "Phone Number",
                "tin": "915555703"
            }
        ],
        "id": "id"
    }
}

User Flow

1. User Input: The user enters business details including business name, FEIN, country, and state.
2. API Call: The KYB Search API is called with the provided business details.
3. Data Retrieval: The API fetches the business details from LexisNexis and returns the verification results.