FFullness Developers

Credit & Passport

Credit API

Request signed financial-health attestations and consented score signals through the implemented B2B service.

POST/api/credit-api/v1/score

Return one signed financial-health credential for a DID and consent token.

POST/api/credit-api/v1/score/batch

Return up to 100 per-DID attestations or inline errors.

GET/api/credit-api/v1/health-signals/{did}

Return premium per-dimension signals behind the composite score.

POST/api/credit-api/v1/webhooks/score-changed

Register a partner score-change webhook.

TypeScript client

The repository package @fullness/credit-api-sdk handles API-key headers, exact-body HMAC and purpose headers. It is supplied to approved integrators; public registry availability is not assumed.

TypeScript
import { CreditApiClient } from '@fullness/credit-api-sdk';

const credit = new CreditApiClient({
  baseUrl: process.env.FULLNESS_CREDIT_API_BASE,
  apiKey: process.env.FULLNESS_CREDIT_API_KEY,
  defaultPurpose: 'credit_scoring',
});

const result = await credit.getScore({
  did: 'did:fullness:subject-issued-by-fullness',
  consent_token: 'consent-token-issued-for-this-release',
});

console.log(result.attestation, result.consent_token_hash);

Score response

The response contains a signed W3C credential and the SHA-256 hash of the supplied consent token for audit correlation. Do not treat a score response as permission to originate credit, move funds or bypass your own regulatory decisioning.

Health signals

The premium endpoint returns the DID, score, scoring window, dimensions, computation hash and computation timestamp. Availability and billable units are partner-tier dependent.

Start typing to search the documentation.