FinanceGenius.AI CRM offers API
The CRM offers API from FinanceGenius.AI — 14 operation(s) for crm offers.
The CRM offers API from FinanceGenius.AI — 14 operation(s) for crm offers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/financegenius-ai:financegenius-ai-crm-offers-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Financegenius Ai CRM offers API
version: 1.0.0
description: 'Operations tagged CRM offers across 2 of this provider''s published API definitions: finmall-openapi.json, financegenius-ai-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: CRM offers
paths:
/api/v1/crm/offers/applications/{application_id}/share:
get:
tags:
- CRM offers
summary: Share Step
description: What the share step shows for the lenders picked (comma-separated codes).
operationId: share_step_api_v1_crm_offers_applications__application_id__share_get
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
- name: lenders
in: query
required: true
schema:
type: string
maxLength: 420
title: Lenders
- name: language
in: query
required: false
schema:
enum:
- en
- hi
type: string
default: en
title: Language
- name: repeat
in: query
required: false
schema:
type: string
maxLength: 420
default: ''
title: Repeat
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- CRM offers
summary: Record Share
description: 'The customer''s explicit consent: which lenders, which data, why (DL 12(iv)); repeat data is separate.'
operationId: record_share_api_v1_crm_offers_applications__application_id__share_post
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ShareIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/applications/{application_id}/share/withdraw:
post:
tags:
- CRM offers
summary: Withdraw Share
operationId: withdraw_share_api_v1_crm_offers_applications__application_id__share_withdraw_post
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WithdrawIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/repeat-data/withdraw:
post:
tags:
- CRM offers
summary: Withdraw Repeat
operationId: withdraw_repeat_api_v1_crm_offers_repeat_data_withdraw_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WithdrawIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/crm/offers/applications/{application_id}/push:
post:
tags:
- CRM offers
summary: Push
description: 'Send the application to one lender the customer shared it with. Refused (with the reason and, for the
enquiry budget, the date it frees up) without share consent, when the budget is spent or the plan warns.'
operationId: push_api_v1_crm_offers_applications__application_id__push_post
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PushIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/my-offers:
get:
tags:
- CRM offers
summary: My Offers
description: Every application the customer shared with lenders, as para 6 views. Each is one logged display.
operationId: my_offers_api_v1_crm_offers_my_offers_get
security:
- HTTPBearer: []
parameters:
- name: sort
in: query
required: false
schema:
enum:
- apr
- emi
- amount
- tenure
type: string
default: apr
title: Sort
- name: language
in: query
required: false
schema:
enum:
- en
- hi
type: string
default: en
title: Language
- name: surface
in: query
required: false
schema:
enum:
- web
- app
type: string
default: web
title: Surface
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/applications/{application_id}/offers:
get:
tags:
- CRM offers
summary: Application Offers
operationId: application_offers_api_v1_crm_offers_applications__application_id__offers_get
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
- name: sort
in: query
required: false
schema:
enum:
- apr
- emi
- amount
- tenure
type: string
default: apr
title: Sort
- name: language
in: query
required: false
schema:
enum:
- en
- hi
type: string
default: en
title: Language
- name: surface
in: query
required: false
schema:
enum:
- web
- app
type: string
default: web
title: Surface
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/applications/{application_id}/offers/{offer_id}/accept:
post:
tags:
- CRM offers
summary: Accept
description: The customer accepts one firm offer, confirming it here. The lender decides what happens next.
operationId: accept_api_v1_crm_offers_applications__application_id__offers__offer_id__accept_post
security:
- HTTPBearer: []
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
- name: offer_id
in: path
required: true
schema:
type: string
format: uuid
title: Offer Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/app__api__v1__crm_offers__AcceptIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/charts:
get:
tags:
- CRM offers
summary: Charts
description: The canonical charts and every lender's journey template, checked against its chart.
operationId: charts_api_v1_crm_offers_charts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/crm/offers/lender-applications/{la_id}/state:
get:
tags:
- CRM offers
summary: Lender Application State
operationId: lender_application_state_api_v1_crm_offers_lender_applications__la_id__state_get
parameters:
- name: la_id
in: path
required: true
schema:
type: string
format: uuid
title: La Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/applications/{application_id}/displays:
get:
tags:
- CRM offers
summary: Displays
description: 'The offer display log: what each para 6 view showed, by which method and ranking metric (R6).'
operationId: displays_api_v1_crm_offers_applications__application_id__displays_get
parameters:
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
title: Application Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/golive:
get:
tags:
- CRM offers
summary: Golive All
operationId: golive_all_api_v1_crm_offers_golive_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/crm/offers/golive/{lender_code}:
get:
tags:
- CRM offers
summary: Golive One
operationId: golive_one_api_v1_crm_offers_golive__lender_code__get
parameters:
- name: lender_code
in: path
required: true
schema:
type: string
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/golive/{lender_code}/run:
post:
tags:
- CRM offers
summary: Golive Run
description: Run the gate on lender-sim and record the result (Founder/Finance; never in production).
operationId: golive_run_api_v1_crm_offers_golive__lender_code__run_post
parameters:
- name: lender_code
in: path
required: true
schema:
type: string
title: Lender Code
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/crm/offers/golive/{lender_code}/record:
post:
tags:
- CRM offers
summary: Golive Record
description: Record a gate report run elsewhere (CI or UAT), once its version and digests match the code here.
operationId: golive_record_api_v1_crm_offers_golive__lender_code__record_post
parameters:
- name: lender_code
in: path
required: true
schema:
type: string
title: Lender Code
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReportIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ReportIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
gate_version:
type: string
maxLength: 20
title: Gate Version
code_digest:
type: string
pattern: ^[0-9a-f]{64}$
title: Code Digest
template_digest:
type: string
pattern: ^[0-9a-f]{64}$
title: Template Digest
run_at:
type: string
maxLength: 40
title: Run At
environment:
type: string
const: lender-sim
title: Environment
default: lender-sim
checks:
items:
additionalProperties: true
type: object
type: array
maxItems: 20
title: Checks
type: object
required:
- lender_code
- gate_version
- code_digest
- template_digest
- run_at
- checks
title: ReportIn
WithdrawIn:
properties:
lender_codes:
anyOf:
- items:
type: string
type: array
maxItems: 10
- type: 'null'
title: Lender Codes
type: object
title: WithdrawIn
ShareIn:
properties:
lenders:
items:
$ref: '#/components/schemas/ShareChoiceIn'
type: array
maxItems: 10
minItems: 1
title: Lenders
language:
type: string
enum:
- en
- hi
title: Language
default: en
share_notice_ref:
type: string
format: uuid
title: Share Notice Ref
share_notice_sha256:
type: string
pattern: ^[0-9a-f]{64}$
title: Share Notice Sha256
disclosure_sha256:
type: string
pattern: ^[0-9a-f]{64}$
title: Disclosure Sha256
method:
type: string
enum:
- checkbox
- button_tap
title: Method
default: checkbox
repeat_data:
items:
type: string
type: array
maxItems: 10
title: Repeat Data
repeat_notice_ref:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Repeat Notice Ref
repeat_notice_sha256:
anyOf:
- type: string
pattern: ^[0-9a-f]{64}$
- type: 'null'
title: Repeat Notice Sha256
surface:
type: string
enum:
- web
- app
title: Surface
default: web
type: object
required:
- lenders
- share_notice_ref
- share_notice_sha256
- disclosure_sha256
title: ShareIn
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
ShareChoiceIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
data_items:
items:
type: string
enum:
- phone
- email
- profile
- application
- bank_statement
- documents
type: array
maxItems: 6
minItems: 1
title: Data Items
type: object
required:
- lender_code
- data_items
title: ShareChoiceIn
PushIn:
properties:
lender_code:
type: string
pattern: ^[a-z][a-z0-9_]{1,39}$
title: Lender Code
type: object
required:
- lender_code
title: PushIn
app__api__v1__crm_offers__AcceptIn:
properties:
display_ref:
type: string
format: uuid
title: Display Ref
terms_sha256:
type: string
pattern: ^[0-9a-f]{64}$
title: Terms Sha256
confirm:
type: boolean
title: Confirm
confirmation:
type: string
enum:
- button_tap
- otp_confirmed
title: Confirmation
default: button_tap
surface:
type: string
enum:
- web
- app
title: Surface
default: web
type: object
required:
- display_ref
- terms_sha256
- confirm
title: AcceptIn
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- finmall-openapi.json
- financegenius-ai-openapi.json
x-provenance:
method: harvested
publisher: FinanceGenius.AI
source: https://api.finmall.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)