Search
K
Embedded Finance

CompanyData

object
company_idstringrequired

An identifier in the partner’s system that uniquely identifies the company to create a token for

currencystringrequired

ISO 4217 code for currency the company uses primarily

Allowed values:USDEURCADAUDGBPCHFDKKNZDXCDXAFXOFXPFAEDAFNALLAMDANGAOAARSAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCDFCLPCLFCNYCOPCOUCRCCUCCUPCVECZKDJFDOPDZDEGPERNETBFJDFKPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMROMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPROMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUYUUZSVEFVESVNDVUVWSTYERZARZMWZWLXDR

Example:GBP

annual_revenueAny Of

Companies annual revenue to the nearest whole number in currency

Example:14000000

Variant 1integer
revenue_in_periodAny Of

Revenue for the company in the specified period to the nearest whole number in currency

Example:7000000

Variant 1integer
shipping_in_periodAny Of

Shipping amount for the company in the specified period to the nearest whole number in currency

Example:60000

Variant 1integer
num_period_monthsAny Of

Number of months the revenue_in_period and shipping_in_period cover

Example:6

Variant 1integer

>= 1<= 12

countrystringrequired

ISO 3166-1 alpha-2 code for the incorporation country of the company

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

stateAny Of

ISO 3166-2 code for the state of the company if applicable

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

incorporation_dateAny Of

Date of incorporation of the company (YYYY-MM-DD). At least one of this or client_onboarding_date, with the former taking precedence

Example:2020-01-15

Variant 1string(date)
client_onboarding_dateAny Of

Date of client onboarding (YYYY-MM-DD). At least one of this or incorporation_date must be provided, with the latter taking precedence

Example:2020-06-30

Variant 1string(date)
Example

CountryCode

string

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

CurrencyCode

string

Allowed values:USDEURCADAUDGBPCHFDKKNZDXCDXAFXOFXPFAEDAFNALLAMDANGAOAARSAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCDFCLPCLFCNYCOPCOUCRCCUCCUPCVECZKDJFDOPDZDEGPERNETBFJDFKPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMROMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPROMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSLLSOSSRDSSPSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUYUUZSVEFVESVNDVUVWSTYERZARZMWZWLXDR

BatchStatus

string

Allowed values:PENDING_UPLOADPROCESSINGPROCESSEDERROR

BatchStatusResponse

object
statusstringrequired

Status of the batch upload

Allowed values:PENDING_UPLOADPROCESSINGPROCESSEDERROR

Example