API Reference
Every endpoint on api.cowdi.co, generated from the OpenAPI contract.
Access
Authentication
Sign in with a custom token and refresh access tokens.
OAuth clients
Credentials an organization issues to call this API.
API version
The API version an organization runs on, the upgrade to the latest version, and the rollback of that upgrade.
Webhooks
Endpoints an organization registers to receive platform events.
Organization
Organizations
The organizations the caller is a member of.
Organization members
Members of an organization and the invitations that add them.
Users
Users of an organization: creation, activation, and search.
Merchants
Merchants an organization onboards and the merchants the caller belongs to.
Merchant members
Members of a merchant and the invitations that add them.
Agents
Field agents of an organization, their customers, and their commissions.
Branding
White-label branding of an organization.
Customer
Profile
The caller's user record, configuration, and profile settings.
Contact details
The caller's email addresses and phone numbers, and their verification.
KYC
Identity verification of a customer before they can transact.
Notification preferences
The channels on which the signed-in user receives notifications.
Notification Inbox
In-app messages for the signed-in user
Legal documents
Terms and other legal texts that customers accept.
Accounts
Accounts
The caller's loan, credit, and current accounts.
Current account
The caller's current account: opening, upgrade, and summary.
Current account activation
OTP-confirmed activation of the caller's current account.
Current account closure
OTP-confirmed closure of the caller's current account.
Current account email verification
OTP-confirmed verification of the current account's email address.
Statements
Account statements and their documents.
Lending
Products
The products that the caller offers, and their versions.
Loan applications
Quotes and applications for the loan products an organization offers.
Refinancing
Replace the debt of a term loan, a revolving credit facility, or a Flex Credit facility with new terms.
Invoice financing
Invoices a merchant submits for buyer review and early payment.
Installments
Installments of a loan or credit account and the repayments allocated to them.
Payments
Identity verification (KYC)
Verify a customer's identity with a selfie and an ID document, or with a selfie alone when Cowdi already holds a recent verification.
Refresh an ID token POST
Exchanges a refresh token for a new ID token and a new refresh token. Any client can call it without a Cowdi access token. The refresh token must come from the sign in operation or an earlier refresh call. Returns 400 with `INVALID_TOKEN` when the refresh token is invalid or expired. Returns 503 with `SERVICE_TEMPORARILY_UNAVAILABLE` when Firebase is not available. Keep the refresh token and send the request again later. Use the new ID token as the Bearer token for further API calls.