--- title: "CompanyData" url: "https://docs.wayflyer.com/apis/embedded-finance-1-0-0/versions/7d0182a3-23d8-43cc-b636-dac7e1594f96/schemas/CompanyData" --- > Full API specification: https://docs.wayflyer.com/apis/embedded-finance-1-0-0/versions/7d0182a3-23d8-43cc-b636-dac7e1594f96.md # CompanyData ## OpenAPI definition ```yaml openapi: 3.1.0 info: title: Embedded Finance version: "1" servers: - url: https://api.wayflyer.com/financing/ description: Production components: schemas: CurrencyCode: enum: - USD - EUR - CAD - AUD - GBP - CHF - DKK - NZD - XCD - XAF - XOF - XPF - AED - AFN - ALL - AMD - ANG - AOA - ARS - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BZD - CDF - CLP - CLF - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DOP - DZD - EGP - ERN - ETB - FJD - FKP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - UYU - UZS - VEF - VES - VND - VUV - WST - YER - ZAR - ZMW - ZWL - XDR title: CurrencyCode type: string CountryCode: enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CD - CG - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - NO - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - MK - RO - RU - RW - RE - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW title: CountryCode type: string USStateCode: enum: - US-AL - US-AK - US-AZ - US-AR - US-CA - US-CO - US-CT - US-DE - US-FL - US-GA - US-HI - US-ID - US-IL - US-IN - US-IA - US-KS - US-KY - US-LA - US-ME - US-MD - US-MA - US-MI - US-MN - US-MS - US-MO - US-MT - US-NE - US-NV - US-NH - US-NJ - US-NM - US-NY - US-NC - US-ND - US-OH - US-OK - US-OR - US-PA - US-RI - US-SC - US-SD - US-TN - US-TX - US-UT - US-VT - US-VA - US-WA - US-WV - US-WI - US-WY - US-DC - US-AS - US-GU - US-MP - US-PR - US-VI title: USStateCode type: string CanadianProvinceCode: enum: - CA-AB - CA-BC - CA-MB - CA-NB - CA-NL - CA-NS - CA-ON - CA-PE - CA-QC - CA-SK - CA-NT - CA-NU - CA-YT title: CanadianProvinceCode type: string CompanyData: properties: company_id: description: An identifier in the partner's system that uniquely identifies the company to create a token for title: Company Id type: string currency: $ref: "#/components/schemas/CurrencyCode" description: ISO 4217 code for currency the company uses primarily examples: - GBP annual_revenue: anyOf: - type: integer - type: "null" description: Companies annual revenue to the nearest whole number in `currency` examples: - 14000000 title: Annual Revenue revenue_in_period: anyOf: - type: integer - type: "null" description: Revenue for the company in the specified period to the nearest whole number in `currency` examples: - 7000000 title: Revenue In Period shipping_in_period: anyOf: - type: integer - type: "null" description: Shipping amount for the company in the specified period to the nearest whole number in `currency` examples: - 60000 title: Shipping In Period num_period_months: anyOf: - maximum: 12 minimum: 1 type: integer - type: "null" description: Number of months the `revenue_in_period` and `shipping_in_period` cover examples: - 6 title: Num Period Months country: $ref: "#/components/schemas/CountryCode" description: ISO 3166-1 alpha-2 code for the incorporation country of the company state: anyOf: - $ref: "#/components/schemas/USStateCode" - $ref: "#/components/schemas/CanadianProvinceCode" - type: "null" description: ISO 3166-2 code for the state of the company if applicable title: State incorporation_date: anyOf: - format: date type: string - type: "null" description: Date of incorporation of the company (YYYY-MM-DD). At least one of this or `client_onboarding_date`, with the former taking precedence examples: - 2020-01-15 title: Incorporation Date client_onboarding_date: anyOf: - format: date type: string - type: "null" description: Date of client onboarding (YYYY-MM-DD). At least one of this or `incorporation_date` must be provided, with the latter taking precedence examples: - 2020-06-30 title: Client Onboarding Date required: - company_id - currency - country title: CompanyData type: object ```