5.8 KiB
5.8 KiB
name, description
| name | description |
|---|---|
| credit-routes | Handle 22 OpenAPI operation(s) under /credit for the credit route group. |
credit API Routes
Handle 22 OpenAPI operation(s) under /credit for the credit route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
credit_audit_copy_token_update
- Operation ID:
credit_audit_copy_token_update - Route:
POST /credit/audit_copy_token/update - Mode: WRITE
- Summary: Update an Audit Copy Token
- Body: JSON request body accepted.
credit_sessions_get
- Operation ID:
credit_sessions_get - Route:
POST /credit/sessions/get - Mode: WRITE
- Summary: Retrieve Link sessions for your user
- Body: JSON request body accepted.
credit_audit_copy_token_create
- Operation ID:
credit_audit_copy_token_create - Route:
POST /credit/audit_copy_token/create - Mode: WRITE
- Summary: Create Asset or Income Report Audit Copy Token
- Body: JSON request body accepted.
credit_report_audit_copy_remove
- Operation ID:
credit_report_audit_copy_remove - Route:
POST /credit/audit_copy_token/remove - Mode: WRITE
- Summary: Remove an Audit Copy token
- Body: JSON request body accepted.
credit_asset_report_freddie_mac_get
- Operation ID:
credit_asset_report_freddie_mac_get - Route:
POST /credit/asset_report/freddie_mac/get - Mode: WRITE
- Summary: Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
- Body: JSON request body accepted.
credit_freddie_mac_reports_get
- Operation ID:
credit_freddie_mac_reports_get - Route:
POST /credit/freddie_mac/reports/get - Mode: WRITE
- Summary: Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
- Body: JSON request body accepted.
credit_bank_income_get
- Operation ID:
credit_bank_income_get - Route:
POST /credit/bank_income/get - Mode: WRITE
- Summary: Retrieve information from the bank accounts used for income verification
- Body: JSON request body accepted.
credit_bank_income_pdf_get
- Operation ID:
credit_bank_income_pdf_get - Route:
POST /credit/bank_income/pdf/get - Mode: WRITE
- Summary: Retrieve information from the bank accounts used for income verification in PDF format
- Body: JSON request body accepted.
credit_bank_income_refresh
- Operation ID:
credit_bank_income_refresh - Route:
POST /credit/bank_income/refresh - Mode: WRITE
- Summary: Refresh a user's bank income information
- Body: JSON request body accepted.
credit_bank_income_webhook_update
- Operation ID:
credit_bank_income_webhook_update - Route:
POST /credit/bank_income/webhook/update - Mode: WRITE
- Summary: Subscribe and unsubscribe to proactive notifications for a user's income profile
- Body: JSON request body accepted.
credit_payroll_income_parsing_config_update
- Operation ID:
credit_payroll_income_parsing_config_update - Route:
POST /credit/payroll_income/parsing_config/update - Mode: WRITE
- Summary: Update the parsing configuration for a document income verification
- Body: JSON request body accepted.
credit_bank_statements_uploads_get
- Operation ID:
credit_bank_statements_uploads_get - Route:
POST /credit/bank_statements/uploads/get - Mode: WRITE
- Summary: Retrieve data for a user's uploaded bank statements
- Body: JSON request body accepted.
credit_payroll_income_get
- Operation ID:
credit_payroll_income_get - Route:
POST /credit/payroll_income/get - Mode: WRITE
- Summary: Retrieve a user's payroll information
- Body: JSON request body accepted.
credit_payroll_income_risk_signals_get
- Operation ID:
credit_payroll_income_risk_signals_get - Route:
POST /credit/payroll_income/risk_signals/get - Mode: WRITE
- Summary: Retrieve fraud insights for a user's manually uploaded document(s).
- Body: JSON request body accepted.
credit_payroll_income_precheck
- Operation ID:
credit_payroll_income_precheck - Route:
POST /credit/payroll_income/precheck - Mode: WRITE
- Summary: Check income verification eligibility and optimize conversion
- Body: JSON request body accepted.
credit_employment_get
- Operation ID:
credit_employment_get - Route:
POST /credit/employment/get - Mode: WRITE
- Summary: Retrieve a summary of an individual's employment information
- Body: JSON request body accepted.
credit_payroll_income_refresh
- Operation ID:
credit_payroll_income_refresh - Route:
POST /credit/payroll_income/refresh - Mode: WRITE
- Summary: Refresh a digital payroll income verification
- Body: JSON request body accepted.
credit_relay_create
- Operation ID:
credit_relay_create - Route:
POST /credit/relay/create - Mode: WRITE
- Summary: Create a relay token to share an Asset Report with a partner client
- Body: JSON request body accepted.
credit_relay_get
- Operation ID:
credit_relay_get - Route:
POST /credit/relay/get - Mode: WRITE
- Summary: Retrieve the reports associated with a relay token that was shared with you
- Body: JSON request body accepted.
credit_relay_pdf_get
- Operation ID:
credit_relay_pdf_get - Route:
POST /credit/relay/pdf/get - Mode: WRITE
- Summary: Retrieve the pdf reports associated with a relay token that was shared with you (beta)
- Body: JSON request body accepted.
credit_relay_refresh
- Operation ID:
credit_relay_refresh - Route:
POST /credit/relay/refresh - Mode: WRITE
- Summary: Refresh a report of a relay token
- Body: JSON request body accepted.
credit_relay_remove
- Operation ID:
credit_relay_remove - Route:
POST /credit/relay/remove - Mode: WRITE
- Summary: Remove relay token
- Body: JSON request body accepted.