# Credentially Documentation

> Documentation for Credentially

## API Reference
- [Getting Started & API key](https://credentially.readme.io/reference/getting-started-with-your-api.md): This page will help you get started with our API.
- [Download OpenAPI specification file](https://credentially.readme.io/reference/download-openapi-json-specification-file.md)
- [Request more endpoints](https://credentially.readme.io/reference/request-more-endpoints.md)
- [Get Dictionary Values](https://credentially.readme.io/reference/getdictionaryvalues.md): Returns the allowed values for a dictionary-type custom profile field. Use the dictionaryId from the jsonSchema returned by GET /api/profile/metadata.  **Rate Limit:** `dictionary-lookup` (100 req / 1s)
- [Load Organisation Group Members](https://credentially.readme.io/reference/loadmembers.md): Fetches members in an organisation group.  **Rate Limit:** `organisation-group-members-add` (25 req / 1s)
- [Add Organisation Group Members](https://credentially.readme.io/reference/addmembers.md): Adds members to an organisation group using job position ids.  **Rate Limit:** `organisation-group-members-add` (25 req / 1s)
- [Delete Organisation Group Members](https://credentially.readme.io/reference/deletemembers.md): Removes members from an organisation group using job position ids.  **Rate Limit:** `organisation-group-members-add` (25 req / 1s)
- [Archive Profile](https://credentially.readme.io/reference/archiveprofile.md): Archives a profile within the organisation.  **Rate Limit:** `archive-profile` (25 req / 1s)
- [Activate Profile](https://credentially.readme.io/reference/activateprofile.md): Activates a profile within the organisation.  **Rate Limit:** `activate-profile` (25 req / 1s)
- [Load Profiles](https://credentially.readme.io/reference/loadprofiles.md): Fetches a paginated list of profiles for the organisation.  **Rate Limit:** `create-profile` (25 req / 1s)
- [Create Profile](https://credentially.readme.io/reference/createprofile.md): Creates a new profile and optionally populates custom fields in a single transaction.  **Rate Limit:** `create-profile` (25 req / 1s)
- [Update Profile Fields](https://credentially.readme.io/reference/updateprofilefields.md): Updates fields for an existing profile identified by email.  **Rate Limit:** `create-profile` (25 req / 1s)
- [Load Profile Notes](https://credentially.readme.io/reference/loadprofilenotes.md): Loads notes for a profile.  **Rate Limit:** `load-profile-notes` (100 req / 1s)
- [Create Profile Note](https://credentially.readme.io/reference/createprofilenote.md): Creates a note for a profile.  **Rate Limit:** `load-profile-notes` (100 req / 1s)
- [Get Profile by ID](https://credentially.readme.io/reference/getprofilebyid.md): Fetches detailed profile information for a profile by their ID, including enriched custom fields.  **Rate Limit:** `delete-profile` (25 req / 1s)
- [Delete Profile](https://credentially.readme.io/reference/deleteprofile.md): Deletes a profile from the organisation.  **Rate Limit:** `delete-profile` (25 req / 1s)
- [Get Profile Metadata](https://credentially.readme.io/reference/getprofilemetadata.md): Fetches and aggregates profile metadata fields (schema) and available roles for the organisation.  **Rate Limit:** `profile-metadata` (10 req / 10s)
- [Get Profile by Email](https://credentially.readme.io/reference/getprofilebyemail.md): Fetches detailed profile information, including enriched custom fields.  **Rate Limit:** `profile-by-email` (100 req / 1s)
- [List All Profiles (Lightweight)](https://credentially.readme.io/reference/loadallprofiles.md): Fetches a non-paginated list of all profiles for the organisation with lightweight information.  **Rate Limit:** `load-all-profiles` (5 req / 1s)
- [Delete Profile Note](https://credentially.readme.io/reference/deleteprofilenote.md): Deletes a note from a profile.  **Rate Limit:** `delete-profile-note` (25 req / 1s)
- [Get Profile Documents](https://credentially.readme.io/reference/getdocuments.md): Fetches documents for a profile, enriched with extra OCR fields.  **Rate Limit:** `get-documents` (100 req / 1s)
- [Upload Profile Document](https://credentially.readme.io/reference/uploaddocument.md): Uploads a document for a specific profile and triggers processing.  **Rate Limit:** `get-documents` (100 req / 1s)
- [Reject document of file.](https://credentially.readme.io/reference/reject.md): Decline specific document and file.  **Rate Limit:** `reject-document` (5 req / 1s)
- [Approve document of file.](https://credentially.readme.io/reference/approve.md): Approve specific document and file.  **Rate Limit:** `approve-document` (5 req / 1s)
- [Download file by its id](https://credentially.readme.io/reference/downloadfile.md): Download file by its id.  **Rate Limit:** `download-file` (5 req / 1s)
- [Get Organisation Document Types](https://credentially.readme.io/reference/getdocumenttypes.md): Fetches document types for an organisation.  **Rate Limit:** `get-document-types` (100 req / 1s)
- [Get all profile's compliance packages](https://credentially.readme.io/reference/getprofilecompliancepackages.md): Fetches a list of all compliance requirements for all assigned packages for the profile.  **Rate Limit:** `profile-compliance-packages` (25 req / 1s)
- [Assign compliance packages to profile](https://credentially.readme.io/reference/assign.md): Assign compliance packages (list of their ids) to profile.  **Rate Limit:** `profile-compliance-packages` (25 req / 1s)
- [Get all organisation's compliance packages](https://credentially.readme.io/reference/getorganisationcompliancepackages.md): Fetches a list of all organisation's compliance packages.  **Rate Limit:** `organisation-compliance-packages` (25 req / 1s)
- [Load Organisation Groups](https://credentially.readme.io/reference/loadallgroups.md): Fetches all existing organisation groups and returns their id and name.  **Rate Limit:** `profile-groups-load` (100 req / 1s)
- [Create Organisation Group](https://credentially.readme.io/reference/creategroup.md): Creates a new organisation group.  **Rate Limit:** `profile-groups-load` (100 req / 1s)
- [Delete Organisation Group](https://credentially.readme.io/reference/deletegroup.md): Deletes an organisation group by public id.  **Rate Limit:** `profile-groups-delete` (25 req / 1s)
- [Update Organisation Group](https://credentially.readme.io/reference/updategroup.md): Updates an existing organisation group.  **Rate Limit:** `profile-groups-delete` (25 req / 1s)
- [Get Profile References](https://credentially.readme.io/reference/getprofilereferences.md): Returns reference titles, employment dates, durations, and status for the requested profile.  **Rate Limit:** `profile-references` (100 req / 1s)
- [Get Profile Right To Work Status](https://credentially.readme.io/reference/getprofilerighttowork.md): Returns the current right to work outcome for the requested profile, including approval details when available.  **Rate Limit:** `profile-right-to-work` (100 req / 1s)
- [Get Profile DBS Checks](https://credentially.readme.io/reference/getprofiledbschecks.md): Returns all DBS checks for the requested profile in the authenticated organisation context. The public `profileId` path parameter maps to the upstream `employeePublicId`.  **Rate Limit:** `profile-dbs-load` (100 req / 1s)
- [Create Or Refresh Profile DBS Check](https://credentially.readme.io/reference/updateprofiledbscheck.md): Creates or refreshes a DBS check for the requested profile in the authenticated organisation context. The public `profileId` path parameter maps to the upstream `employeePublicId`. Provide the certificate details exactly as shown on the DBS certificate.  **Rate Limit:** `profile-dbs-load` (100 req / 1s)
- [Get Profile DBS Check](https://credentially.readme.io/reference/getprofiledbscheck.md): Returns a single DBS check for the requested profile in the authenticated organisation context. The public `profileId` path parameter maps to the upstream `employeePublicId`.  **Rate Limit:** `profile-dbs-by-id` (100 req / 1s)
- [Process and auto-fill fields from a new document](https://credentially.readme.io/reference/autofillprocess.md): Processes a newly uploaded file and returns extracted fields, validation outcome, and OCR metadata.  **Rate Limit:** `shared-intensive-write-limit` (25 req / 1s)
- [Auto-fill fields from an existing document](https://credentially.readme.io/reference/autofillexisting.md): Extracts structured field values from an existing stored document using your target schema.  **Rate Limit:** `shared-intensive-write-limit` (25 req / 1s)
- [Subscriptions](https://credentially.readme.io/reference/subscriptions.md): Webhook behaviour
- [getsubscriptions](https://credentially.readme.io/reference/getsubscriptions.md)
- [createsubscription](https://credentially.readme.io/reference/createsubscription.md)
- [deletesubscription](https://credentially.readme.io/reference/deletesubscription.md)
- [getavailableeventtypes](https://credentially.readme.io/reference/getavailableeventtypes.md)