---
updatedAt: 2026-08-03T21:40:34.000Z
agentTools:
  projectIndex: https://developer.greendot.com/embedded-finance/llms.txt
---

# Prerequisites & Onboarding

# Overview

Before integration development or testing can begin, a set of configuration values and credentials must be provisioned by Green Dot. This is not a self-service process - all items below are delivered by your Green Dot integration contact.

***

## Required Items

| Item                       | Description                                                                                                            | Provided By                                |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| **Azure AD Credentials**   | `clientId` and `clientSecret` per environment                                                                          | Green Dot                                  |
| **EC Public Key**          | Elliptic curve public key per environment, used to encrypt customer PII before sending it to the API                   | Green Dot                                  |
| **Program Code**           | `{PROGRAM_CODE}` - identifies your integration in all API paths                                                        | Green Dot                                  |
| **Product Code**           | `{PRODUCT_CODE}` - identifies the Green Dot product                                                                    | Green Dot                                  |
| **Product Material Types** | `{PRODUCT_MATERIAL_TYPE_VIRTUAL}` and `{PRODUCT_MATERIAL_TYPE_EMV}` - used in Enrollment and Order Card requests       | Green Dot                                  |
| **Terms Identifiers**      | The exact list of `termsIdentifier` values required for your product, and their required `termsAcceptanceFlag` values  | Green Dot (confirmed during product setup) |
| **APIM Audience ID**       | Per-environment Azure AD audience ID - used in the token scope                                                         | Green Dot                                  |
| **Base URLs**              | Per-environment API base URLs                                                                                          | Green Dot                                  |
| **Outbound IP Ranges**     | Partner must provide their outbound IP ranges to Green Dot for firewall allowlisting                                   | **Partner provides to Green Dot**          |
| **Order Card Trigger**     | Partner determines and implements the business condition (e.g., refund received) that triggers the Order Card API call | **Partner implements**                     |

***

## Environment Base URLs

| Environment     | Base URL               | Notes            |
| --------------- | ---------------------- | ---------------- |
| DEV             | `{DEV_BASE_URL}`       |                  |
| QA              | `{QA_BASE_URL}`        |                  |
| PIE (East US)   | `{PIE_EAST_BASE_URL}`  |                  |
| PIE (West US3)  | `{PIE_WEST_BASE_URL}`  |                  |
| PROD (East US)  | `{PROD_EAST_BASE_URL}` | Primary          |
| PROD (West US3) | `{PROD_WEST_BASE_URL}` | Secondary region |

Full API path pattern:

```
{BASE_URL}/programs/{PROGRAM_CODE}/enrollment      ← Enrollment
{BASE_URL}/programs/{PROGRAM_CODE}/lifecycleEvent  ← Order Card
{BASE_URL}/healthcheck                             ← Health Check
```

***

## Azure AD Tenant & Audience IDs

The tenant ID is the same across all environments. The audience ID is per-environment and is used to construct the OAuth 2.0 token scope.

| Environment | Tenant ID     | Audience ID          |
| ----------- | ------------- | -------------------- |
| DEV         | `{TENANT_ID}` | `{DEV_AUDIENCE_ID}`  |
| QA          | `{TENANT_ID}` | `{QA_AUDIENCE_ID}`   |
| PIE         | `{TENANT_ID}` | `{PIE_AUDIENCE_ID}`  |
| PROD        | `{TENANT_ID}` | `{PROD_AUDIENCE_ID}` |

***

## Onboarding Checklist

Use this checklist to confirm you are ready to begin integration development.

**Received from Green Dot:**

* [ ] `clientId` and `clientSecret` for DEV / QA environments
* [ ] EC public key for DEV / QA environments
* [ ] `programCode` confirmed
* [ ] `productCode` confirmed
* [ ] `productMaterialType` values confirmed (virtual and EMV)
* [ ] Required `termsIdentifier` list and expected flag values confirmed
* [ ] APIM Audience IDs confirmed
* [ ] Base URLs confirmed for target environments

**Provided to Green Dot:**

* [ ] Outbound IP ranges submitted for firewall allowlisting

**Partner implementation ready:**

* [ ] OAuth 2.0 token acquisition implemented with caching and auto-refresh
* [ ] EC\_v1 PII encryption implemented using GD's EC public key
* [ ] Order Card business trigger logic defined and implemented
* [ ] HTTP client timeout set to at least 35 seconds
* [ ] Connectivity verified using the `/healthcheck` endpoint

***

## Getting Help

Contact your Green Dot integration contact for:

* Credential provisioning
* Terms identifier confirmation
* IP allowlisting
* Questions about product setup or go-live readiness

***

## Next Steps

* [Authentication](https://developer.greendot.com/embedded-finance/docs/referral-partner-integration-authentication) - how to obtain and use Azure AD Bearer tokens

* [API Reference](https://developer.greendot.com/embedded-finance/docs/referral-partner-integration-api-reference) - endpoint specifications, field rules, and error catalogs