{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/user-interface/settings/api-credentials/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

API credentials

\n

The Ripple Payments API calls require Bearer authentication tokens that you retrieve from the authentication operation using API credentials. This topic explains how to create and rotate an API credential.

\n

\"API

\n
Note

Each environment can have up to three credentials.

\n

Prerequisites

\n

Your user needs to have permissions to view and edit API credentials.
To check your API Credentials permissions, select \"User > Profile.

\n

Create new credential

\n

To create an API credential consisting of a client ID and client secret (credential):

\n
    \n
  1. \nLog in to \nRipple Payments\n.\n
    2. \n
  2. \nOn the top right of the page, click the \nSettings\n gear icon.\n
    3. \n
  3. \nUnder \nIntegration\n, select \nAPI Credentials\n.\n
    4. \n
  4. \nOn the top right of the page, next to the \n\"Question\n icon, select the access environment for which you want to create API credentials. \n
    \nFor example, to provision credentials for the UAT environment, select \nUAT\n from the dropdown list.\n
    5. \n
  5. \nClick \nNew Credential\n.\n
    6. \n
  6. \nIn the \nCredential name\n field, enter a name for the credential.\n

    \"API

    \n
    7. \n
  7. \nClick \nSave & Generate Key\n.\n

    The Ripple Payments UI presents a dialog box with the client ID and audience that you’ll use with the credential, together with the credential itself.

    \n
    Security

    The credential is displayed only once and you won’t be able to view it again after exiting the page. Copy and store the client secret (credential) securely and share it with authorized individuals in accordance with your organization's security policy.

    \n

    \"API

    \n
    8. \n
  8. \nTo finish credential creation, click \nClose.\n
    9. \n
\n\n

You can now use the client ID and client secret to generate access tokens using the authentication operation. For more information, see Authentication.

\n

We recommend rotating your API credentials at regular intervals in accordance with your organization's security policy.

\n

Rotate credential

\n

Rotating credentials is the process of changing your password and replacing your cryptographic key for accessing RippleNet.

\n

To rotate your RippleNet credential:

\n
    \n
  1. \nSelect \nRotate Credential\n from the dropdown menu in the credential card and confirm your choice.\n
    2. \n
\n

\"API

\n
    \n
  1. \nClick the \nRotate Credential\n button to confirm.\n
    2. \n
\n

\"API

\n
    \n
  1. \nOnce again, copy the credential and store it in a secure location because you won’t be able to view it later.\n
    2. \n
","headings":[{"value":"API credentials","depth":1},{"value":"Prerequisites","depth":2},{"value":"Create new credential","depth":2},{"value":"Rotate credential","depth":2}]},"contentItem":{"data":{"lastModified":"2025-11-13T00:24:58.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":true,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"ba43729d-9e82-590b-a4c6-b10c2f610605__redocly content/user-interface/settings/api-credentials/","seo":{"title":"API credentials","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"user-interface/settings/api-credentials.md","pageBaseUrl":"/user-interface/settings/api-credentials","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"API credentials","id":"api-credentials"},{"depth":2,"value":"Prerequisites","id":"prerequisites"},{"depth":2,"value":"Create new credential","id":"create-new-credential"},{"depth":2,"value":"Rotate credential","id":"rotate-credential"}]},"data":{"title":""},"catalogInfo":null,"link":"/user-interface/settings/api-credentials/","sidebarName":"__root-sidebar__-data-69308394-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}