Sign in

v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYB > Profile Management

Get Business Profile

Endpoint used to get business profile data

get/verify/get_business_profile/{business_profile_id}

Path parameters

business_profile_idstring required

business profile id

Response

Successful operation

namestring

The business name. (Legal name preferred)

alternate_namestring

Alternate business name. (DBA)

tax_identification_numberstring

Tax ID

websitestring

The business website

formation_datestring

The formation date in YYYY-MM-DD format

country_codestring

A 2-letter ISO country code where business is primarily registered.

state_codestring

State Code of the province/region where business is primarily registered.

business_entity_idstring

Entity ID given by the government to the business.

phone_numbersstring[]

List of phone numbers associated with this business

email_addressesstring[]

List of email addresses associated with this business

client_reference_idstring

An id you want to associate with the business profile.

client_reference_dataobject

A JSON you want to associate with the business profile.

callback_urlstring
events_callback_urlstring
tagsstring[]

List of tag names associated with this business profile

verification_session_idsstring[]

List of verification sessions run against this business

business_profile_idstring
business_profile_result'APPROVED' | 'DECLINED' | 'REVIEW' | 'UNKNOWN' | 'FOUND' | 'NOT_FOUND'

The result status of an API request. Possible values are APPROVED, DECLINED, REVIEW, UNKNOWN, FOUND, and NOT_FOUND.

lifecycle_status'PROFILE_NOT_SUBMITTED' | 'ONBOARDING_SESSIONS_PENDING' | 'READY_FOR_REVIEW' | 'ADDITIONAL_INFO_REQUESTED' | 'MONITORING_UPDATES' | 'SESSIONS_EXPIRED' nullable

The current lifecycle status of the business profile

questions_responseobject
created_atinteger
updated_atinteger