--- title: "Get overview" method: GET path: "/core/kyb" tags: ["KYB"] --- # Get overview `GET /core/kyb` ## Request - Base URL: `https://api.enterprise.sandbox.uphold.com` - URL: `https://api.enterprise.sandbox.uphold.com/core/kyb` - Auth: OAuth 2 - Client credentials - Token URL: `/core/oauth2/token` scopes: `core.kyb:read` - TypeScript: (a function with typed inputs; its response is checked against the schema) Get the KYB overview of a business user. ## Query parameters - `detailed` string[] ## Headers - `X-On-Behalf-Of` string - `X-Uphold-User-Ip` union - string, ipv4 - string, ipv6 - `X-Uphold-User-Agent` string - `X-Uphold-User-Origin` string - `X-Uphold-User-Country` string - `X-Uphold-User-Subdivision` string - `X-Uphold-User-City` string ## Response `200` KYB overview retrieved. - KybOverview - `summary` object, required - `status` 'blocked' | 'ok' | 'pending' | 'restricted', required: The overall KYB status. - `reason` string, required: Additional reason for the status. - `processes` object, required - `profile` KybProfile, required: The KYB profile object. - `code` 'profile', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `input` object: Input of the KYB process. - `legalEntityType` 'government-entity' | 'non-profit' | 'partnership' | 'private-limited-company' | 'public-company' | 'sole-proprietor', required: Business legal form/classification. - `legalEntityName` string: The full legal entity name. - `formationDate` string, date: The date of the business formation. - `industry` union - union: The industry classification of the business. Allowed `subSector` values depend on the selected `sector`. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - `sector` 'other', required - `otherSector` string: Free-form description of the sector and sub-sector. - `legalIds` object[]: The legal identifiers of the business, usually government-issued. - `type` 'tax-id' | 'registration-id', required: The type of the legal identifier. - `id` string, required: The legal identifier value. - `country` string, required: The country of the legal identifier. - `registrationAddress` object, required: The registration address of the business. - `country` string, required: The country of the address. - `subdivision` string: The subdivision of the address. - `city` string: The city of the address. - `line1` string: The first line of the address. - `line2` string: The second line of the address. - `postalCode` string: The postal code of the address. - `operatingAddress` object, required: The operating address of the business. - `country` string: The country of the address. - `subdivision` string: The subdivision of the address. - `city` string: The city of the address. - `line1` string: The first line of the address. - `line2` string: The second line of the address. - `postalCode` string: The postal code of the address. - `associatedPersons` KybAssociatedPersons, required: The KYB associated persons object. - `code` 'associated-persons', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `persons` KybAssociatedPerson[]: The list of associated persons. - `id` string, uuid, required: The unique identifier for the associated person. - `processes` KybAssociatedPersonProcesses, required: The processes for an associated person. - `profile` KybAssociatedPersonProfile, required: The profile process for an associated person. - `code` 'profile', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `input` union - … - `identity` union, required - object: The identity process for an associated person. - … - object: The identity process for an associated person. - … - `proofOfAddress` union, required - object: The proof-of-address process for an associated person. - … - object: The proof-of-address process for an associated person. - … - `createdAt` string, date-time, required: The date and time when the associated person was created. - `documents` KybDocuments, required: The KYB documents object. - `code` 'documents', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `input` object: Input of the KYB process. - `incorporation` object: The document evidencing the incorporation of the business. - `fileId` string, uuid, required: The id of the file. - `ownership` object: The document evidencing the ownership of the business, such as the beneficial owners. - `fileId` string, uuid, required: The id of the file. - `control` object: The document evidencing who controls the business, such as directors and/or officers. - `fileId` string, uuid, required: The id of the file. - `standing` object: The document evidencing that the business is still active. - `fileId` string, uuid, required: The id of the file. - `taxIdentity` object: The document evidencing the tax identity of the business. - `fileId` string, uuid, required: The id of the file. - `financialInstitution` KybFinancialInstitution, required: The KYB financial institution object. - `code` 'financial-institution', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `input` object: Input of the KYB process. - `regulatorsAndLicenses` string: Details about who the business is regulated by, and what licenses they have. - `moneyTransmitterLicenses` string: Details about their money transmitter license (number / issuer). - `compliancePolicies` KybDocument - `fileId` string, uuid, required: The id of the file. - `amlAudit` KybDocument - `fileId` string, uuid, required: The id of the file. - `mlroDocumentation` KybDocument - `fileId` string, uuid, required: The id of the file. - `attestation` KybAttestation, required: The KYB attestation object. - `code` 'attestation', required: The code of the KYB process. - `status` 'ok' | 'failed' | 'running' | 'pending' | 'exempt', required: Status of the KYB process. - `output` object: Output of the KYB process. - `checks` union[], required: The list of checks performed as part of the KYB attestation. - union - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … ## Other responses - `401`: Unauthorized. - `403`: Forbidden. - `409`: Business logic error. - `429`: Too Many Requests. --- [API](https://skmtc.dev/uphold/apis/core-api.md) - [All operations](https://skmtc.dev/uphold/apis/core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/core-api/revisions/6c663575c57a?raw)