API Overview

Welcome to the CreditRisk API Developer Portal. This documentation will help you integrate with our trade credit management platform.

Getting Started

To use the CreditRisk API, you'll need to:

  1. Get API Access: Contact us to obtain your API access token
  2. Authenticate User: POST to /api/auth?api_token=xxx with username/password
  3. Use Access Tokens: Include the returned access_token in subsequent requests
  4. Refresh When Needed: Use the refresh token when access tokens expire

Base URL

https://api.creditrisk.co.za

Available Endpoints

Authentication
  • POST /api/auth - Authenticate and get access + refresh tokens
  • POST /api/refresh - Refresh expired access tokens
  • POST /api/logout - Revoke user tokens (logout)
Application Management
  • POST /api/send_application_invite - Send application invite (requires authentication)
  • POST /api/password_reset_request - Request password reset
  • POST /api/password_reset - Reset password with token

Authentication Types

API Access Token

• General API access control
• Required for all endpoints
• UUID format (36 characters)

Access Token

• User-specific authentication
• JWT format
• Expires after set time
• Use refresh token to renew