Retrieve company

Request

Security:

path Parameters

company_guid required	string <uuid>
version required	string

Responses

200

Company request and response info from kyb

400

Bad request.

401

Unauthorized

404

Company not found

500

Server Error

get/api/{version}/companies/{company_guid}/retrieve

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/companies/{company_guid}/retrieve' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"company_details": {"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",
"company_dba_city": "string",
"company_dba_state": "string",
"company_dba_country": "str",
"institution_type": "string",
"company_status": "string",
"sys_utcinserted": "2019-08-24T14:15:22Z",
"sys_utcupdated": "2019-08-24T14:15:22Z",
"address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"phone_number": "string",
"website": "string",
"ownership_type": "string",
"incorporation_state": "string",
"incorporation_country": "str",
"incorportation_date": "2019-08-24T14:15:22Z",
"additional_data": "string"
},
"due_diligence_data": {"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"
},
"kyb_provider_data": {"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"
}
}
}