Reliability Credential
Generate payment reliability credentials based on a user's payment history. Credentials can be shared with landlords, lenders, and service providers as proof of payment reliability.
/api/v1/credentialEndpoints
POST
/api/v1/credential/generateSoonGenerate a new reliability credential
GET
/api/v1/credential/{credential_id}/verifySoonVerify a credential's authenticity
GET
/api/v1/credential/{credential_id}/exportSoonExport credential as PDF or JSON
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | Required | User identifier |
| scope | array | Optional | Payment categories to include (default: all) |
| period_months | integer | Optional | Lookback period in months (default: 12, max: 36) |
Example
Request
http
POST /api/v1/credential/generate HTTP/1.1
Host: api.tpay365.com
Authorization: Bearer sk_live_abc123
Content-Type: application/json
{
"user_id": "usr_8821-9920",
"scope": ["rent", "utilities", "subscriptions"],
"period_months": 12
}Response
json
{
"credential_id": "cred_xyz789",
"user_id": "usr_8821-9920",
"reliability_score": 94,
"on_time_rate": "0.97",
"total_payments": 144,
"missed_payments": 4,
"period": "2025-02-10 to 2026-02-10",
"issued_at": "2026-02-10T14:30:00Z",
"expires_at": "2026-08-10T14:30:00Z"
}