Skip to main content

Already Know Finance API

Revision: ff4158e

Welcome to the work-in-progress technical overview of the Already Know Finance platform. This document outlines the core components and functionalities that power our service, from our unique authentication system to our advanced GenAI-powered phone call automation.

Auth​

POST/auth/nativeAuthenticate a consumer
POST/sign-upRegister a new consumer

Consumer​

GET/consumerGet consumer business object
POST/consumer/updateUpdate a consumer's information
POST/consumer/password/updateUpdate a consumer's password
POST/consumer/participation/updateUpdate a consumer's participation code
PUT/consumer/calls/schemas/credit-cards/balance-sheetUpdate a consumer's credit card balance sheet
GET/consumer/calls/schemas/credit-cards/balance-sheetsGet a consumer's credit card balance sheet

Call​

POST/call/start-callsInitialize calls for phone schema transcripting
POST/call/caller-id/verifyVerify "Caller ID" claim
POST/call/caller-id/verify/codeVerify a "Caller ID" verification code
POST/call/schemas/credit-cards/_intervalCall sync heartbeat

Challenge​

GET/challenge/email/verify/{onboarding-ticket}/{email}Verify consumer's email address
GET/challenge/email/verification/resendResend email verification
POST/challenge/email/password/reset/sendInitiate password reset
POST/challenge/email/password/resetComplete password reset

Health Checks​

GET/_healthHealth check