Embedded Finance Sandbox

Get user details

Get user details for the authenticated user.

Returns the current user details including email and phone number.
User is extracted from the authentication token.

get
https://sandbox-api.wayflyer.com/financing/company/user-details/

Headers

API-Versionstring

Allowed values:1

Response

application/json

OK

UserDetailsResponse

emailAny Of

The email of the user

Variant 1string(email)
first_nameAny Of

The first name of the user

Variant 1string
last_nameAny Of

The last name of the user

Variant 1string
phone_numberAny Of

The phone number of the user in E.164 format

Variant 1string
get/company/user-details/
 
application/json

Update user details

Update user details for the authenticated user.

User details can only be updated a few times before any application is submitted to prevent abuse. User details
cannot be updated after an application is submitted.

put
https://sandbox-api.wayflyer.com/financing/company/user-details/

Headers

API-Versionstring

Allowed values:1

Body

application/json

UserDetailsRequest

emailstring(email)required

The email of the user

first_nameAny Of

The first name of the user

Variant 1string

<= 255 characters

last_nameAny Of

The last name of the user

Variant 1string

<= 255 characters

phone_numberAny Of

The user’s phone number in E.164 format (e.g., +353861234567)

Variant 1string

<= 16 characters

Response

application/json

OK

UserDetailsResponse

emailAny Of

The email of the user

Variant 1string(email)
first_nameAny Of

The first name of the user

Variant 1string
last_nameAny Of

The last name of the user

Variant 1string
phone_numberAny Of

The phone number of the user in E.164 format

Variant 1string
put/company/user-details/

Body

{ "email": "email" }
 
application/json

Hand over a user to Wayflyer

Generate a URL to redirect the user to Wayflyer where they can continue their funding application.

Requires the company to have an open hosted application.

post
https://sandbox-api.wayflyer.com/financing/company/handover/

Headers

API-Versionstring

Allowed values:1

Response

application/json

OK

HandoverResponse

urlstringrequired
post/company/handover/
 
application/json

Get company details

Get company details for the authenticated company.

get
https://sandbox-api.wayflyer.com/financing/company/company-details/

Headers

API-Versionstring

Allowed values:1

Response

application/json

OK

CompanyDetailsResponse

country_codeAny Of

ISO 3166-1 alpha-2 country code

CountryCodestring

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

state_codeAny 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

principal_place_of_businessAny Of

US state where the company primarily operates

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

legal_namestringrequired

Legal name of the company

registration_numberAny Of

Company registration number

Variant 1string
business_typeAny Of

Legal business type — null for non-US companies

BusinessTypestring

Allowed values:limited_partnershiplimited_liability_partnershiplimited_liability_companycorporationcooperativeother

revenueintegerrequired

Monthly revenue in the smallest whole currency unit

> 0

revenue_currencystringrequired

ISO 4217 currency code

Allowed values:USDCADAUDEURGBPSEKDKK

industry_codestringrequired

TRBC industry classification code

industry_namestringrequired

Human-readable industry name

date_of_incorporationstring(date)required

Date the company was incorporated

customer_segmentsarray[string]required

Customer segments

Allowed values:b2cb2b

sales_channelsarray[string]required

Sales channels

Allowed values:onlineoffline

product_offeringsarray[string]required

Product offerings

Allowed values:physicaldigital_productsservicessubscriptions

website_urlAny Of

Company website URL

Variant 1string
get/company/company-details/
 
application/json

Update company details

Replace company details for the authenticated company.

Company details can only be updated a limited number of times and cannot be updated after an application is
submitted.

put
https://sandbox-api.wayflyer.com/financing/company/company-details/

Headers

API-Versionstring

Allowed values:1

Body

application/json

CompanyDetailsRequest

country_codeAny Of

ISO 3166-1 alpha-2 country code

CountryCodestring

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

state_codeAny 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

principal_place_of_businessAny Of

Required when country_code is US; must be omitted otherwise

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

legal_namestringrequired

Legal name of the company

registration_numberAny Of

Company registration number

Variant 1string
business_typeAny Of

Legal business type — required when country_code is US; must be null or omitted otherwise

BusinessTypestring

Allowed values:limited_partnershiplimited_liability_partnershiplimited_liability_companycorporationcooperativeother

revenueintegerrequired

Monthly revenue in the smallest whole currency unit

> 0

revenue_currencystringrequired

ISO 4217 currency code

Allowed values:USDCADAUDEURGBPSEKDKK

industry_codestringrequired

TRBC industry classification code

>= 10 characters<= 10 characters

date_of_incorporationstring(date)required

Date the company was incorporated

customer_segmentsarray[string]required

Customer segments

Allowed values:b2cb2b

>= 1 items

sales_channelsarray[string]required

Sales channels

Allowed values:onlineoffline

>= 1 items

product_offeringsarray[string]required

Product offerings

Allowed values:physicaldigital_productsservicessubscriptions

>= 1 items

website_urlAny Of

Company website URL

Variant 1string

Response

application/json

OK

CompanyDetailsResponse

country_codeAny Of

ISO 3166-1 alpha-2 country code

CountryCodestring

Allowed values:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRCIHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZW

state_codeAny 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

principal_place_of_businessAny Of

US state where the company primarily operates

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

legal_namestringrequired

Legal name of the company

registration_numberAny Of

Company registration number

Variant 1string
business_typeAny Of

Legal business type — null for non-US companies

BusinessTypestring

Allowed values:limited_partnershiplimited_liability_partnershiplimited_liability_companycorporationcooperativeother

revenueintegerrequired

Monthly revenue in the smallest whole currency unit

> 0

revenue_currencystringrequired

ISO 4217 currency code

Allowed values:USDCADAUDEURGBPSEKDKK

industry_codestringrequired

TRBC industry classification code

industry_namestringrequired

Human-readable industry name

date_of_incorporationstring(date)required

Date the company was incorporated

customer_segmentsarray[string]required

Customer segments

Allowed values:b2cb2b

sales_channelsarray[string]required

Sales channels

Allowed values:onlineoffline

product_offeringsarray[string]required

Product offerings

Allowed values:physicaldigital_productsservicessubscriptions

website_urlAny Of

Company website URL

Variant 1string
put/company/company-details/

Body

{ "legal_name": "legal_name", "revenue": 0, "revenue_currency": "USD", "industry_code": "industry_code", "date_of_incorporation": "date_of_incorporation", "customer_segments": [ "b2c" ], "sales_channels": [ "online" ], "product_offerings": [ "physical" ] }
 
application/json