API credentials let your systems authenticate against Cobre APIs. Each credential has a User ID, a Secret, and a Role that defines what the credential can do through the API.From the Portal you can create credentials with the role you need, review the ones you already have, and delete the ones you no longer use.
Accessing API Credentials#
In the left menu, open Developers and select the API Credentials tab.Viewing Your Credentials#
The title shows how many credentials you have out of the maximum, for example Credentials (9 of 10). The table displays:| Column | Description |
|---|
| Alias | The name you gave the credential |
| User ID | System identifier of the credential (starts with cli_) |
| Role | The access level of the credential: Read-only or Full access |
| Creator | The Portal user who created the credential |
| Creation date | When the credential was created |
Use Edit columns to choose which columns the table shows. Hover over a row to reveal its actions: copy the credential's ID or delete it. The newest credential appears first.
Roles#
The role defines what a credential can do through the API.| Role | What the credential can do |
|---|
| Read-only | Can query information through the API. Cannot create, modify or delete information, or run operations. |
| Full access | Can query information and run the operations available through the API. |
The role cannot be changed after the credential is created.
Credentials created before roles were introduced appear as Full access.
Creating a Credential#
Select + Create credential in the top-right corner of the table. The New API Credential window opens.1.
Enter an Alias (up to 256 characters) that helps you identify the credential.
2.
Select a Role: Read-only or Full access. No role is selected by default.
3.
If you selected Full access, tick the confirmation: "I understand this credential will have full access and will be able to run operations through the API, including payments and money movements." You cannot continue without it.
4.
Select Create credential.
5.
Enter the 6-digit security code generated by your two-factor authentication application and select Continue.
6.
Copy the User ID and the Secret from the API Credential window, then select Accept.
The credential appears at the top of the table.Store the Secret in a safe place before you close the window. For security reasons, you will not be able to see it again in the Cobre Portal. If you lose it, you must create a new credential.
Credential Limit#
You can have up to 10 credentials. When you reach the limit, + Create credential is disabled and the Portal shows the message "You have reached the limit of 10 allowed API credentials." Delete a credential you no longer use to create a new one.Using Your Credential#
Use the User ID and the Secret to authenticate against the Cobre API. See the Authentication API Guide for the full flow.
Deleting a Credential#
Hover over the credential's row and select the delete icon. Enter the 6-digit security code generated by your two-factor authentication application. The Portal confirms with Credential deleted and the credential leaves the table.Deleting a credential is irreversible. If you need it again, you must create a new one.
Permissions#
Creating and deleting credentials depends on your Portal permissions. If you do not see + Create credential or the delete action, your Portal role does not include that permission.