eKYB

URL Expired

The URL for this request expired after 30 days.

Plugins

• plugins: array of strings
• businessName: string
  • Name of the business
• addressLine1: string
  • Address line 1 of the business
• street: string
  • Street name of the business address
• houseNo: string
  • The exterior number of the business address
• addressLine2: string
  • Address line 2 of the business
• city: string
  • City of the business address.
• state: string
  • State of the business address.
• postalCode: string
  • Postal code of the business address.
• country: string
  • Two-letter country code of the business address
• taxId: string
  • The tax id of the business
• uboName: string
  • Deprecated — Ultimate Beneficial Owner name. Use uboNames instead.
• uboNames: array of strings
  • Ultimate Beneficial Owners names
• directors: array of strings
  • Names of the directors of the business
• api-version: string
  • required, Defaults to 1.0

Status Codes

200 Status codes for business name:

• status: Success, sub_label: Verified, label: Match identified to the submitted Business Name
• status: Warning, sub_label: Similar Match, label: Similar match identified to the submitted Business Name
• status: Failure, sub_label: Unverified, label: Unable to identify a match to the submitted Business Name
• status: Failure, sub_label: Alternate Name, label: We believe the submitted TIN is associated with "name"

Status codes for address verification:

• status: Success, sub_label: Verified, label: Match identified to the submitted Business Name
• status: Warning, sub_label: Similar Match, label: Similar match identified to the submitted Business Name
• status: Failure, sub_label: Unverified, label: Unable to identify a match to the submitted Business Name
• status: Failure, sub_label: Alternate Name, label: We believe the submitted TIN is associated with "name"

Status codes for address property type:

• status: Success, sub_label: Commercial, label: Submitted Office Address is a Commercial property
• status: Warning, sub_label: Residential, label: Submitted Office Address is a Residential property

Status codes for address deliverability:

• status: Success, sub_label: Deliverable, label: The USPS is able to deliver mail to the submitted Office Address
• status: Failure, sub_label: Undeliverable, label: The USPS is unable to deliver mail to the submitted Office Address

Example

{
    "kyb": [
        {
            "key": "name",
            "status": "success",
            "sub_label": "Verified",
            "message": "Match identified to the submitted Business Name"
        },
        {
            "key": "address_verification",
            "status": "success",
            "sub_label": "Verified",
            "message": "Match identified to the submitted Office Address"
        },
        {
            "key": "address_deliverability",
            "status": "success",
            "sub_label": "Deliverable",
            "message": "The USPS is able to deliver mail to the submitted Office Address"
        },
        {
            "key": "address_property_type",
            "status": "success",
            "sub_label": "Commercial",
            "message": "Submitted Office Address is a Commercial property"
        }
    ]
}

Error Code

400 Bad Request

Curl Example

curl --request POST \
     --url https://demo-api.incodesmile.com/omni/externalVerification/ekyb \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json'