---
title: Get API credentials
slug: get-started/quickstart/get-api-credentials
description: Register for Cross River APIs, obtain your access token, and ensure your IP is allowlisted to access the sandbox environment successfully.
docTags: 
createdAt: 2025-02-18T09:03:36.631Z
---

:::Iframe{iframeHeight="0" code="<div class=&#x22;stepper&#x22;>&#xA;  <a href=&#x22;/get-started/quickstart/get-api-credentials&#x22; class=&#x22;step active&#x22;>&#xA;    <div class=&#x22;step-check&#x22;>&#xA;      <div class=&#x22;step-disc&#x22;></div>&#xA;      <div class=&#x22;step-disc-active&#x22;></div>&#xA;    </div>&#xA;    <div class=&#x22;step-num&#x22;>Step 1</div>&#xA;    <div class=&#x22;step-title&#x22;>Get API credentials</div>&#xA;  </a>&#xA;  <a href=&#x22;/get-started/quickstart/get-access-token&#x22; class=&#x22;step&#x22;>&#xA;    <div class=&#x22;step-check&#x22;>&#xA;      <div class=&#x22;step-disc&#x22;></div>&#xA;      <div class=&#x22;step-disc-active&#x22;></div>&#xA;    </div>&#xA;    <div class=&#x22;step-num&#x22;>Step 2</div>&#xA;    <div class=&#x22;step-title&#x22;>Get Access Token</div>&#xA;  </a>&#xA;  <a href=&#x22;/get-started/quickstart/use-access-token&#x22; class=&#x22;step&#x22;>&#xA;    <div class=&#x22;step-check&#x22;>&#xA;      <div class=&#x22;step-disc&#x22;></div>&#xA;      <div class=&#x22;step-disc-active&#x22;></div>&#xA;    </div>&#xA;    <div class=&#x22;step-num&#x22;>Step 3</div>&#xA;    <div class=&#x22;step-title&#x22;>Use Access Token</div>&#xA;  </a>&#xA;</div>"}

:::

***

## API access setup

Your first step to working with Cross River APIs is to request API credentials. With these credentials you can request and receive an access token to use for sending APIs in our sandbox environment.

Sandbox is a **non-production environment** and behaves differently from production systems in terms of data handling, stability, and security controls.&#x20;

Sandbox is intended to simulate behavior, not replicate production data scenario&#x73;**&#x20;using real data**.

**Always use test data in sandbox environments.**

## ⚠️ Important: Do not use real customer data

**Do not use real customer data in sandbox under any circumstances.&#x20;**

This includes:

- Personally Identifiable Information (PII)
- Names, email addresses, phone numbers
- Account numbers or financial identifiers
- Any data that belongs to a real individual or business
- Any data that could be traced back to a real customer

## Why this matters

Sandbox is designed for testing, not data protection or storage of sensitive information. Using real data in Sandbox may result in:

- Data exposure in logs or debugging tools
- Unintended visibility to support or engineering teams
- Mixing of test and production data patterns
- Compliance and regulatory risk for your organization

:::hint{type="warning"}
**IMPORTANT**
Your IP address, which must be public and static, has to be on our allowlist. Your internal IT department should be able to provide you with this IP.  Learn more about [static IPs](docId\:z3wbkvnCkkie3kEJtxLI9).
:::

## Sandbox access

To get API credentials, [submit a request](https://crossriver.service-now.com/csm?id=cos_sandbox_request_form\&sys_id=713de878c300b5105d3eafdc7a013184\&sysparm_category=df09f2623310c2906b697d934d5c7b4a). You will complete a form that includes providing a static IP.

Once your static IP is added to our allowlist, we send you 2 encrypted emails with your credentials:&#x20;

- One email contains your `client_id`, `partner_id` and other information you'll need depending on what you have requested.&#x20;
- The second email, which is encrypted, contains your `client_secret` and `webhook_secret`. You'll need these for authentication and for working in the sandbox.&#x20;

