Onboarding and provisioning

🇨🇴 Leer en español →

Before you integrate with Prosperas, you need credentials. Prosperas
does not offer self-registration: we generate and
deliver your credentials manually and securely. This page explains how
to get started, what we’ll ask you for, and what you’ll receive.

---

To get started #

Email rclose@prosperas.com
with the following:

• Your company name
• Target market (Colombia / Mexico)
• A technical contact (name and email of the person
  who will coordinate the integration)
• Your preferred authentication method (API key / IP
  allowlist / both)

With that, we’ll provision your credentials and the base URLs for
your market. This email is the single entry point to onboarding.

---

How you get your credential #

Prosperas does not offer self-registration. We generate a secret key
tied to your account and deliver it through a secure out-of-band
channel — never via plaintext email or chat.

We support two credential types:

1. API key (recommended). A secret key we deliver
   through a secure out-of-band channel. It is sent with each request via
   the X-API-KEY header.

2. IP allowlist. We register the stable, public IP
   addresses your requests originate from. Calls coming from authorized IPs
   authenticate automatically, with no additional headers.

You may use either method, or both. We prefer API keys because they
adapt better to infrastructure with changing IPs.

Security note

• The documentation never displays real API keys; examples use
  placeholders like <your-api-key>.
• Prosperas’ internal endpoints for credential registration
  are not documented and must never be called by
  integrators: they are for internal use only.
• Never share credentials across environments.

Environments by market #

Prosperas runs separate staging and
production environments, with market-specific URLs
(Colombia or Mexico). Throughout the documentation you’ll see the
{BASE_URL} placeholder: the real staging and production
values are delivered to you during onboarding.

Illustrative
example of how {BASE_URL} resolves #

These values are an illustrative example, NOT the real
URLs. They exist only so you can see the shape of a resolved
base URL. The real values for your market are delivered to you during
onboarding.

• Staging (Colombia):
  https://api.staging.co.prosperas.com
• Production (Colombia):
  https://api.co.prosperas.com

The general shape is the same for every market-and-environment
combination:

Market	Staging (illustrative example)	Production (illustrative example)
Colombia (CO)	https://api.staging.co.prosperas.com	https://api.co.prosperas.com
Mexico (MX)	https://api.staging.mx.prosperas.com	https://api.mx.prosperas.com

Again: the hostnames above are illustrative. Always use the exact
values we deliver at onboarding.

What each environment is for #

Environment	Use
Staging	Integration testing and request validation before going to production
Production	Live consumer traffic

Critical rule Do not mix credentials or URLs across
environments. Staging credentials do not work against production, and
vice versa.

What we need you to share #

Your technical team must provide:

• Credential type preference: API key, IP allowlist,
  or both.
• Stable egress IPs (if using the allowlist): fixed,
  public server addresses only. We do not support ranges; each individual
  IP must be registered separately.
• Technical contact to coordinate credential delivery
  and go-live support.

What Prosperas delivers #

Once provisioning is complete, you’ll receive:

• The credential (API key via secure out-of-band channel, or IP
  allowlist confirmation).
• The staging and production base URLs for your market.

---

Last verified: 2026-07-01 · v1.1