Skip to main content
common.logoAltFreshCredit®INC
docs.gettingStarted.label /

docs.gettingStarted.title

docs.gettingStarted.description

docs.gettingStarted.integrationSteps /
docs.gettingStarted.step 01

docs.gettingStarted.steps.createAccount

docs.gettingStarted.steps.createAccountDesc

docs.gettingStarted.step 02

docs.gettingStarted.steps.getApiKeys

docs.gettingStarted.steps.getApiKeysDesc

// Your API credentials
const API_KEY = 'fc_live_xxxxxxxxxxxxxxxx'
const API_SECRET = 'fc_secret_xxxxxxxxxxxxxxxx'
docs.gettingStarted.step 03

docs.gettingStarted.steps.firstRequest

docs.gettingStarted.steps.firstRequestDesc

curl -X GET https://api.freshcredit.com/v1/health \
  -H "Authorization: Bearer fc_live_xxxxxxxxxxxxxxxx" \
  -H "X-FreshCredit-Signature: {hmac_signature}" \
  -H "Content-Type: application/json"
docs.gettingStarted.step 04

docs.gettingStarted.steps.integrateBlockId

docs.gettingStarted.steps.integrateBlockIdDesc

const response = await fetch('https://api.freshcredit.com/v1/blockid/verify', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'X-FreshCredit-Signature': signature,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    user_id: 'user_123',
    verification_type: 'kyc_basic',
  }),
});
docs.gettingStarted.coreConcepts /

docs.gettingStarted.concepts.selfCustody

docs.gettingStarted.concepts.selfCustodyDesc

docs.gettingStarted.concepts.eventDriven

docs.gettingStarted.concepts.eventDrivenDesc

docs.gettingStarted.concepts.tieredAccess

docs.gettingStarted.concepts.tieredAccessDesc

docs.gettingStarted.concepts.restfulApi

docs.gettingStarted.concepts.restfulApiDesc