Perform company kyb

returns company status info of kyb

SecurityBearer
Request
path Parameters
version
required
string
Request Body schema: application/json
company_guid
required
string <uuid>

Company Guid

top_program_guid
string <uuid>

Top Program Guid

Array of objects or null (AddressDTO)

Business Addresses

required
object (PersonContactInfo)
object (PersonContactInfo)
Array of objects or null (BeneficialOwnerPersonInfo)

Company beneficial owner info

required
object (BeneficialOwnerPersonInfo)
object (ParentCompanyInfo)
company_kyb_override
boolean
company_status
string or null
object (CompanyDocument)
Responses
201

Returns company status info sent for kyb

400

Bad Request

401

Unauthorized

404

Not Found

500

Server Error

post/api/{version}/companies/performkyb
Request samples
application/json
{
  • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
  • "top_program_guid": "c67bc77e-3255-4696-a119-8c3b1cf9b3b3",
  • "addresses": [
    • {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      }
    ],
  • "primary_contact": {
    • "first_name": "string",
    • "last_name": "string",
    • "title": "string",
    • "phone_number": "string",
    • "email_address": "string"
    },
  • "secondary_contact": {
    • "first_name": "string",
    • "last_name": "string",
    • "title": "string",
    • "phone_number": "string",
    • "email_address": "string"
    },
  • "beneficial_owner": [
    • {
      • "first_name": "string",
      • "middle_name": "string",
      • "last_name": "string",
      • "title": [
        • {
          • "object": "string",
          • "title": "string"
          }
        ],
      • "phone_number": "string",
      • "email": "string",
      • "beneficial_owner_type": "INDIVIDUAL",
      • "ssn": "string",
      • "last_four_ssn": "string",
      • "dob": "string",
      • "beneficial_ownership": 100,
      • "bo_for_company_name": "string",
      • "beneficial_company_lic": "string",
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      }
    ],
  • "controller_officer_info": {
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "title": [
      • {
        • "object": "string",
        • "title": "string"
        }
      ],
    • "phone_number": "string",
    • "email": "string",
    • "beneficial_owner_type": "INDIVIDUAL",
    • "ssn": "string",
    • "last_four_ssn": "string",
    • "dob": "string",
    • "beneficial_ownership": 100,
    • "bo_for_company_name": "string",
    • "beneficial_company_lic": "string",
    • "city": "string",
    • "country": "str",
    • "address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string"
    },
  • "parent_company_info": {
    • "has_parent_company": true,
    • "parent_company_name": "string",
    • "parent_company_contact_info": {
      • "first_name": "string",
      • "last_name": "string",
      • "title": "string",
      • "phone_number": "string",
      • "email_address": "string"
      },
    • "parent_company_lic": "string"
    },
  • "company_kyb_override": true,
  • "company_status": "string",
  • "document": {
    • "document_type": "CORPORATE",
    • "file_type": "PDF",
    • "issuing_country": "string",
    • "articles_of_incorporation_document": "string",
    • "attestation_document": "string"
    }
}
Response samples
application/json
{
  • "performKybInfoRequest": {
    • "company_guid": "e7c8755b-aece-46c7-a1c9-897cfb55ba0c",
    • "top_program_guid": "c67bc77e-3255-4696-a119-8c3b1cf9b3b3",
    • "addresses": [
      • {
        • "city": "string",
        • "country": "str",
        • "address_line1": "string",
        • "address_line2": "string",
        • "postal_code": "string",
        • "state": "string"
        }
      ],
    • "primary_contact": {
      • "first_name": "string",
      • "last_name": "string",
      • "title": "string",
      • "phone_number": "string",
      • "email_address": "string"
      },
    • "secondary_contact": {
      • "first_name": "string",
      • "last_name": "string",
      • "title": "string",
      • "phone_number": "string",
      • "email_address": "string"
      },
    • "beneficial_owner": [
      • {
        • "name": "string",
        • "first_name": "string",
        • "middle_name": "string",
        • "last_name": "string",
        • "title": [
          • {
            • "object": "string",
            • "title": "string"
            }
          ],
        • "phone_number": "string",
        • "email": "string",
        • "ownership_type": "INDIVIDUAL",
        • "ssn": "string",
        • "last_four_ssn": "string",
        • "dob": "string",
        • "beneficial_ownership": 100,
        • "beneficial_company_name": "string",
        • "beneficial_company_lic": "string",
        • "city": "string",
        • "country": "str",
        • "address_line1": "string",
        • "address_line2": "string",
        • "postal_code": "string",
        • "state": "string"
        }
      ],
    • "controller_officer_info": {
      • "first_name": "string",
      • "middle_name": "string",
      • "last_name": "string",
      • "title": [
        • {
          • "object": "string",
          • "title": "string"
          }
        ],
      • "phone_number": "string",
      • "email": "string",
      • "beneficial_owner_type": "INDIVIDUAL",
      • "ssn": "string",
      • "last_four_ssn": "string",
      • "dob": "string",
      • "beneficial_ownership": 100,
      • "bo_for_company_name": "string",
      • "beneficial_company_lic": "string",
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "parent_company_info": {
      • "has_parent_company": true,
      • "parent_company_name": "string",
      • "parent_company_contact_info": {
        • "first_name": "string",
        • "last_name": "string",
        • "title": "string",
        • "phone_number": "string",
        • "email_address": "string"
        },
      • "parent_company_lic": "string"
      },
    • "company_kyb_override": true,
    • "company_status": "string"
    },
  • "provider_reference_id": "string",
  • "status": "string",
  • "provider_response": {
    • "response_description": [
      • {
        • "key": "string",
        • "label": "string",
        • "message": "string",
        • "status": "string",
        • "sub_label": "string"
        }
      ]
    },
  • "response_tin": {
    • "mismatch": true,
    • "unknown": true,
    • "verified": true,
    • "error": "string"
    }
}
Copyright © Qolo 2019-2023. All right reserved.