Get Company Compliance Profile
Changed onReturns the KYB and credit risk status for the company's default legal entity.
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | View companies (company:read) | Manage companies (company:write) |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/companies/{company_id}/compliance-profile
- Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:read, company:write, company_admin, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:read, company:write, company_admin, all:write, all:read)
Path parameters
A unique identifier in UUID v4 format.
Company ID
Response
Success
Example response
{
"data": {
"compliance_profile": {
"credit_risk_status": "no_deposit_required",
"kyb_status": "pass"
}
}
}Changes
- info
the security scope
company_adminwas added to the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_adminwas added to the endpoint's security schemeOAuth2ClientCredentials - info
the security scope
company_managementwas removed from the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_managementwas removed from the endpoint's security schemeOAuth2ClientCredentials
- info
- info
the security scope
company_managementwas added to the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_managementwas added to the endpoint's security schemeOAuth2ClientCredentials - info
the security scope
company_adminwas removed from the endpoint's security schemeOAuth2AuthorizationCode - info
the security scope
company_adminwas removed from the endpoint's security schemeOAuth2ClientCredentials
- info