Customer Onboarding & Integration

How this connects to scoring

Onboarding does not replace scoring — it enriches it. When you call POST /v1/transactions/score, send the same stable userId you used as customerId here so rules can use KYC, PEP, and list context.

Base URL & auth

Base URL: https://api.maiguard.com

Core sequence

1. 1Onboard or update each customer with PUT /v1/customers/:customerId/onboard.
2. 2Use the same customerId as userId when scoring transactions.
3. 3Maintain tenant lists and entries for jurisdictions, PEP-style lists, or custom watchlists.
4. 4List and verify customers via GET /v1/customers as needed.

Endpoint matrix

Examples

1// PUT /v1/customers/:customerId/onboard (same ID as userId in scoring)
2const response = await fetch('https://api.maiguard.com/v1/customers/customer_001/onboard', {
3  method: 'PUT',
4  headers: {
5    'Content-Type': 'application/json',
6    'Authorization': 'Bearer pk_live_<your-key>',
7  },
8  body: `{
9  "riskProfile": "medium",
10  "partnerOnboardedAt": "2025-06-01T00:00:00.000Z",
11  "countryCode": "NG",
12  "entityType": "individual",
13  "displayName": "Amara Osei",
14  "kycStatus": "verified",
15  "kycTier": 2,
16  "pep": false,
17  "expectedVolume": 5000000,
18  "expectedVolumePeriod": "monthly"
19}`,
20});

Errors & status codes

All error responses use a consistent envelope:

{
  "error": "Validation Error",
  "message": "Validation failed",
  "details": [{ "path": ["riskProfile"], "message": "Required field" }]
}

Rate limits

Per-endpoint limits for transaction scoring differ from onboarding. See the full rate-limit table when integrating scoring alongside onboarding.