KYB - Basic + Supplemental

Documentation: KYB (Know Your Business)

This document describes the data structure for capturing company details. The provided data structure offers information about a specific company, its primary contact person, and its associated address details.

Endpoint

URL: https://api.satschel.com/v2/aml/kyb?type=supplemental (POST)

Overall Structure

provider: The name of the information source or data provider.
name: The official name of the company.
website: The official website URL of the company.
fein: The Federal Employer Identification Number (FEIN) of the company.
linkedInUrl: The LinkedIn profile URL of the company.
address: An object that contains detailed address information of the company.
person: An object containing details about a contact person associated with the company.

Address Object

street_address1: The primary address line.
street_address2: The secondary address line (if any). Can be null.
city: The city where the company is located.
state: The state where the company is located.
postal_code: The postal code or ZIP code of the company's location.
type: Type of the address (e.g., "Billing", "Shipping"). Can be null.
phone: The primary phone number of the company.

Person Object

firstName: The first name of the contact person.
lastName: The last name of the contact person.

Sample Data (POST)

{
    "provider": "LEXIS_NEXIS",
    "name": "Satschel",
    "website": "https://satschel.com/",
    "fein": "866741152",
    "linkedInUrl": "https://www.linkedin.com/company/Satschel",
    "address": {
        "street_address1": "30,Augusta Canyon Way",
        "street_address2": null,
        "city": "Las Vegas",
        "state": "NV",
        "postal_code": "80341",
        "type": null,
        "phone": "415516179"
    },
    "person": {
        "firstName": "Austin",
        "lastName": "Trombley"
    }
}

Documentation: Company Verification Output

This section describes the data structure of the output returned by the KYB (Know Your Business) API after processing a company's details.

Overall Structure:

CompanyResults: This contains verification metrics about the company.
request_result: Indicates the success or failure status of the request.
AuthorizedRepresentativeResults: Contains verification details about the company's authorized representative.

CompanyResults:

1. VerifiedInput:

CompanyName: Name of the company that was input for verification.

2. VerificationIndicators:

Binary indicators (where 1 means verified and 0 means not verified) for:

CompanyName
StreetAddress
City
State
Zip
Phone
FEIN

3. BestInformation:

CompanyName: Best verified company name.
Address: Contains components like StreetNumber, StreetName, StreetSuffix, StreetAddress1, City, State, Zip5, and Zip4.
Phone: Best verified phone number.
FEIN: Best verified FEIN.

4. BusinessIds:

Unique business identification numbers like DotID, EmpID, POWID, ProxID, SeleID, OrgID, UltID.

5. BusinessVerification:

Index: A numeric identifier or reference.
Description: Provides feedback about the verification.

6. RiskIndicators:

Each item in this list has:

RiskCode: Identifier for the risk.
Description: Description of the risk.
Sequence: Sequence order.

7. ResidentialBusinesses:

Indicator: A flag (e.g., 1 might indicate true).
Description: Description, such as "Potential Sole Proprietor".

8. VerificationSummaries:

List of summaries detailing the verification sources:

Type: Source type.
Index: Numeric identifier.
Description: Feedback on the verification from this source.

9. BusinessToAuthorizedRepLinkIndexes:

Details the link between the business and its authorized representative.

10. Compliance:

The compliance object provides detailed information about a business's compliance status and related details. Here is a breakdown of the fields within the compliance object:

SICCode: The Standard Industrial Classification (SIC) code associated with the business. In this case, it is "7371," indicating that the business is involved in COMPUTER PROGRAMMING SERVICES.
SOSFilingName: The name under which the business is registered for State of Secretary (SOS) filings. In this case, it is "SATSCHEL GENESIS LLC."
TimeOnSOS: The duration, in days, since the business's SOS filing. It has been "29" days since the filing.
SOSStatus: The status of the business on the State of Secretary (SOS) records. In this case, it is "ACTIVE."
LNStatus: The status of the business's LN (Legal Name) records. It is also "ACTIVE."
TimeOnPublicRecord: The duration, in days, since the business's information has been on public record. It has been "29" days since it became public.
County: The county in which the business is located. Here, it is "CLARK."
BusinessFirstSeenYYYY: The year in which the business was first seen or recorded. In this case, it is "2021."
Parent: This field contains additional information about the parent company, if applicable. It includes:
- BusinessIds: A sub-object containing various identification numbers:
  - SeleID: Selection ID, which is "0" in this case.
  - OrgID: Organization ID, also "0."
  - UltID: Ultimate ID, again "0."

This compliance object is essential for understanding the compliance and legal status of the business entity.

11. AddressRisk:

AddressIsCMRA: Boolean value (true or false) indicating potential risks with the address.

AuthorizedRepresentativeResults:

Name: Full name of the authorized representative.
Sequence: A unique identifier.
Address: Address details of the representative.
AddressType: The type of the address.
DOB: Date of birth of the representative.
Age: Age of the representative.
ComprehensiveVerificationIndex: An index or score related to verification.

Sample Output:

{
  "CompanyResults": {
    "VerifiedInput": {
      "CompanyName": "AMAZON"
    },
    "VerificationIndicators": {
      "CompanyName": "1",
      "StreetAddress": "0",
      "City": "0",
      "State": "0",
      "Zip": "0",
      "Phone": "0",
      "FEIN": "0"
    },
    "BestInformation": {
      "CompanyName": "AMAZON.COM, INC.",
      "Address": {
        "StreetNumber": "2020",
        "StreetName": "EUCLID",
        "StreetSuffix": "AVE",
        "StreetAddress1": "2020 EUCLID AVE",
        "City": "CLEVELAND",
        "State": "OH",
        "Zip5": "44115",
        "Zip4": "2281"
      },
      "Phone": "2165231247",
      "FEIN": "911646860"
    },
    "BusinessIds": {
      "DotID": "0",
      "EmpID": "0",
      "POWID": "133769147089",
      "ProxID": "133769147089",
      "SeleID": "133769147089",
      "OrgID": "133769147089",
      "UltID": "133769147089"
    },
    "BusinessVerification": {
      "Index": "10",
      "Description": "Only input business name could be found on a business record."
    },
    "RiskIndicators": {
      "RiskIndicator": [
        {
          "RiskCode": "20",
          "Description": "Unable to verify business address on business records",
          "Sequence": "1"
        },
        {
          "RiskCode": "21",
          "Description": "Unable to verify business TIN on business records",
          "Sequence": "2"
        },
        {
          "RiskCode": "22",
          "Description": "Unable to verify business phone number on business records",
          "Sequence": "3"
        },
        {
          "RiskCode": "34",
          "Description": "The input business address may be a residential address (single family dwelling)",
          "Sequence": "4"
        },
        {
          "RiskCode": "37",
          "Description": "The input business TIN is not found",
          "Sequence": "5"
        }
      ]
    },
    "ResidentialBusinesses": {
      "ResidentialBusiness": [
        {
          "Indicator": "1",
          "Description": "Potential Sole Proprietor"
        }
      ]
    },
    "VerificationSummaries": {
      "VerificationSummary": [
        {
          "Type": "PHONESOURCE",
          "Index": "1",
          "Description": "Input Business Name verified"
        },
        {
          "Type": "BUREAU",
          "Index": "1",
          "Description": "Input Business Name verified"
        },
        {
          "Type": "GOVTREGISTRATIONS",
          "Index": "0",
          "Description": "No business inputs verified on this source"
        },
        {
          "Type": "PUBLICRECORDFILINGS",
          "Index": "0",
          "Description": "No business inputs verified on this source"
        },
        {
          "Type": "BUSDIRECTORIES",
          "Index": "0",
          "Description": "No business inputs verified on this source"
        }
      ]
    },
    "BusinessToAuthorizedRepLinkIndexes": {
      "BusinessToAuthorizedRepLinkIndex": [
        {
          "InputRepNumber": "1",
          "Index": "0",
          "Description": "The input authorized rep cannot be linked to the business."
        }
      ]
    },
    "Compliance": {
  "SICCode": "7371",
  "SICDescription": "COMPUTER PROGRAMMING SERVICES",
  "SOSFilingName": "SATSCHEL GENESIS LLC",
  "TimeOnSOS": "29",
  "SOSStatus": "ACTIVE",
  "LNStatus": "ACTIVE",
  "TimeOnPublicRecord": "29",
  "County": "CLARK",
  "BusinessFirstSeenYYYY": "2021",
  "Parent": {
    "BusinessIds": {
      "SeleID": "0",
      "OrgID": "0",
      "UltID": "0"
    }
  }
},
    "AddressRisk": {
      "AddressIsCMRA": "false"
    }
  },
  "request_result": "success",
  "AuthorizedRepresentativeResults": {
    "Name": {
      "First": "SAGAR",
      "Last": "SINGH"
    },
    "Sequence": "1",
    "Address": {
      "StreetNumber": "3245",
      "StreetName": "MAYFIELD",
      "StreetSuffix": "RD",
      "UnitDesignation": "APT",
      "UnitNumber": "12",
      "StreetAddress1": "3245 MAYFIELD ROAD APT 12, CLEVELAND HEIGHTS, OH 44118-1869",
      "City": "CLEVELAND HEIGHTS",
      "State": "OH",
      "Zip5": "44118"
    },
    "AddressType": "H",
    "DOB": {
      "Year": "1982",
      "Month": "11",
      "Day": "16"
    },
    "Age": "40",
    "ComprehensiveVerificationIndex": "10"
  }
}

Suggest Edits

KYB Reports API

Before making requests to the KYC Reports API, you need to generate an access token. Follow the guide provided in the Getting Started section of our documentation to generate an access token.

Overview

The Simplici KYB (Know Your Business) Reports API v2 is used to verify and assess the risk of businesses by using the provided business information and the authorized representative’s information.

Endpoint

https://api.satschel.com/v2/kyb/entity

Method

POST

Request Headers

Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN.

Request Body

Below is an example of the JSON payload you should send in the HTTP body:

{
    "callbackUrl": "https://yourcallbackurl.com",
    "companyName": "YourCompanyName",
    "website": "https://yourcompanywebsite.com",
    "companyAddress": {
        "streetAddress1": "Your Street Address",
        "streetAddress2": "Your Suite or Unit Number",
        "city": "Your City",
        "state": "Your State",
        "zip": "Your ZIP Code"
    },
    "phone": "YourPhoneNum",
    "ein": "YourEIN",
    "accountRepresentative": {
        "firstName": "RepFirstName",
        "lastName": "RepLastName",
        "address": {
            "streetAddress1": "Rep Street Address",
            "streetAddress2": "Rep Suite or Unit Number",
            "city": "Rep City",
            "state": "Rep State",
            "zip": "Rep ZIP Code"
        },
        "dateOfBirth": "RepDOB",
        "ssnNumber": "RepSSN",
        "phone": "RepPhoneNum"
    }
}

Direct Response:

Response Example without callback URL

{
    "message": "ok",
    "data": {
        "result": {
            "companyInformation": {
                "companyName": {
                    "value": "SATSCHEL",
                    "isVerified": "1"
                },
                // ... other company information fields ...
                "businessBankruptcy": {
                    "bankruptcy_flag": false,
                    "bankruptcy_records": []
                }
            },
            "authorizedRepresentative": {
                "uniqueId": "3206130349",
                "name": {
                    "first": "BOB",
                    "last": "Tale"
                },
                // ... other authorized representative fields ...
                "verificationScore": {
                    "score": 60,
                    "description": "The input authorized rep's first and last name matches the first and last name of a business contact on record."
                }
            },
            "apiResult": {
                "requestResult": "success",
                "reviewStatus": "pass",
                "riskRating": "neutral"
            }
        },
        "_id": "560b1ea1-79ee-442a-817f-f95a6827c58a"
    }
}

Callback Response

If the callback field is provided in the request, the API will send the KYB report to the provided callback URL as a webhook once the report is ready. In this case, the immediate API response will be as follows:

{
    "message": "ok",
    "data": {
        "_id": "c9895dc8-5bc3-41b2-85df-ab4345cd4289"
    }
}

You can later retrieve the KYB report by making a GET request to https://api.satschel.com/v2/kyb/entity/{Id}.

If the callback field is not provided, the API will return the KYB report directly in the response.

Updated over 1 year ago