Create company

returns new company/program created

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json

create company request

object (CompanyRequest)

Company Request DTO

object (ProgramRequest)

Program Request DTO

Responses
201

Returns the company/program created

400

Bad Request

401

Unauthorized

404

Not Found

500

Server Error

post/api/{version}/companies
Request samples
application/json
{
  • "company": {
    • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
    • "company_parent": "2c870253-a4cb-4256-8be8-44da1d89518c",
    • "company_dba_name": "string",
    • "company_short_name": "string",
    • "company_dba_lic_number": "string",
    • "address_line1": "string",
    • "address_line2": "string",
    • "company_dba_city": "string",
    • "company_dba_state": "string",
    • "company_dba_country": "str",
    • "institution_type": "NONFINANCIAL",
    • "postal_code": "string",
    • "phone_number": "string",
    • "website": "string",
    • "ownership_type": "string",
    • "state_of_incorporation": "string",
    • "country_of_incorporation": "str",
    • "date_of_incorporation": "2019-08-24T14:15:22Z",
    • "additional_data": "string"
    },
  • "program": {
    • "program_name": "string",
    • "parent_program_guid": "4c73d8e3-85f7-42e5-9a39-2376fdcc4881",
    • "eft_display_name": "string",
    • "program_short_name": "string"
    }
}
Response samples
application/json
{
  • "company": {
    • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
    • "company_parent": "2c870253-a4cb-4256-8be8-44da1d89518c",
    • "company_top": "e5db884c-a57e-4674-9f04-d110d9af9451",
    • "company_dba_name": "string",
    • "company_short_name": "string",
    • "company_dba_lic_number": "string",
    • "address_line1": "string",
    • "address_line2": "string",
    • "company_dba_city": "string",
    • "company_dba_state": "string",
    • "company_dba_country": "string",
    • "institution_type": "NONFINANCIAL",
    • "company_status": "UNVERIFIED",
    • "postal_code": "string",
    • "phone_number": "string",
    • "website": "string",
    • "ownership_type": "string",
    • "state_of_incorporation": "string",
    • "country_of_incorporation": "str",
    • "date_of_incorporation": "2019-08-24T14:15:22Z",
    • "additional_data": "string"
    },
  • "program": {
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
    • "program_name": "string",
    • "program_short_name": "string",
    • "eft_display_name": "string",
    • "parent_program_guid": "4c73d8e3-85f7-42e5-9a39-2376fdcc4881",
    • "top_program_guid": "c67bc77e-3255-4696-a119-8c3b1cf9b3b3",
    • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
    • "program_group_guid": "b710e542-e602-49db-ad90-214ddc5c2b82",
    • "bank_product_program_guid": "6f473d9d-2a35-437f-9334-26e89e184e52",
    • "client_id": "string"
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.