Become an integrator

Access to the External API requires partner registration with the Sweep team. There is no self-service signup: contact Sweep through the partner channel to start onboarding.

What you provide

Item	Required	Notes
Technical contact	Yes	Used for credential delivery and incident escalation
Environments needed	Yes	Staging and production credentials are issued separately
Webhook callback URL	Optional	HTTPS endpoint for lifecycle webhooks; configured server-side per partner
Requested integrator fee	Optional	Integer `feeBps` markup you plan to send; Sweep configures the per-partner cap (300 bps default)
Provider preferences	Optional	Restricts which routing providers serve your traffic

What you receive

Environment-specific values, delivered per environment:


SWEEP_API_URL
SWEEP_PARTNER_ID
SWEEP_PARTNER_SECRET
SWEEP_AUTH_VERSION=2

Sweep also holds server-side partner configuration that cannot be changed per request: the authentication version, the allowed callback URL, the maximum integrator fee and the provider policy.

Credential rules

The partner secret exists only in the backend secret store. Never ship it in browser JavaScript, a mobile bundle or a wallet extension.
Staging and production credentials are separate; do not reuse either across environments.
Do not infer production values from examples or third-party sources. If a value is missing, ask Sweep.

Verify your setup

Sign and send GET /ping. A 200 with your partnerId confirms credentials, clock and signature implementation before any product code exists.

Support

Contact Sweep through the partner channel when:

credentials or environment URLs are missing;
an API response differs from the published OpenAPI contract;
a provider remains unavailable or settlement is delayed;
a webhook cannot be verified;
an attempt contains ambiguous execution evidence;
a production incident affects users.

Include safe diagnostic context:


environment
partnerId
intentSessionId
attemptId
timestamp and timezone
chainId
transaction hash or bundle id
HTTP status and Sweep error code

Never send the partner secret, X-Signature values, wallet private keys, seed phrases or a user’s complete signed authorization payload.