Search
K
Embedded Finance

CompanyDetailsSearchResponse

object
resultsarray[object]required

List of matching companies

Show Child Parameters
Example

CompanyDetailsSearchResult

object
namestringrequired

Name of the company

registration_numberstringrequired

Company registration number

registered_addressAny Of
required

Company registered address

Variant 1string
incorporation_dateAny Of
required

Company incorporation date

Variant 1string(date)
Example

CompanyDetailsSearchRequest

object
business_namestringrequired

Name of the company to search for

>= 3 characters<= 200 characters

countrystringrequired

ISO 3166-1 alpha-2 country code

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

stateAny Of

ISO 3166-2 code for US states or Canadian provinces

USStateCodestring

Allowed values:US-ALUS-AKUS-AZUS-ARUS-CAUS-COUS-CTUS-DEUS-FLUS-GAUS-HIUS-IDUS-ILUS-INUS-IAUS-KSUS-KYUS-LAUS-MEUS-MDUS-MAUS-MIUS-MNUS-MSUS-MOUS-MTUS-NEUS-NVUS-NHUS-NJUS-NMUS-NYUS-NCUS-NDUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VTUS-VAUS-WAUS-WVUS-WIUS-WYUS-DCUS-ASUS-GUUS-MPUS-PRUS-VI

Example

EmbeddedApplicationDetailStatus

object
namestringrequired

The name of the detail

Allowed values:user_detailscompany_details

statusstringrequired

The status of the detail, either complete or incomplete

Allowed values:completeincomplete

Example

EmbeddedApplicationStatusResponse

object
application_idAny Of
required

The ID of the embedded application

Variant 1string(uuid)
required_detailsarray[object]required

A list of required details to submit the embedded application.

Show Child Parameters
Example