Yumi Partner API

Yumi provides credit limits and the full credit lifecycle for your users. You send us user and transaction data; we underwrite and return a credit limit; your users draw credit up to that limit; you report repayments.

Everything is server-to-server. You authenticate with an Ed25519 key pair that you control — Yumi never sees your private key.

The integration loop

1. Send us user + transaction data for each of your users.
2. We underwrite them and push back a credit limit via webhook.
3. Your users draw credit up to that limit; you call us to authorize each draw.
4. You report repayments back to us.

Core concepts

Term	Meaning
Application / partner id (name)	Your identity in Yumi. Assigned by Yumi during onboarding. Carried automatically inside your access token — you never pass it explicitly.
externalUserId	Your stable id for one of your users. You send it on every user-scoped call.
Access token	A short-lived JWT you mint by signing a payload with your private key. Sent as Authorization: Bearer ….
Webhook	An outbound POST from Yumi to your endpoint (e.g. a new credit limit), signed with your webhook secret.

Conventions

• Base URL — confirm your environment with your Yumi contact:
  • Staging: https://<staging-host>
  • Production: https://<production-host>
• Content type — application/json for all requests and responses.
• Success envelope:

  { "success": true, "data": { "...": "..." } }

• Amounts are in USD (decimal numbers).

Next: Onboarding →