Skip to content
Docs

System details

System Details

View as Markdown
On this page· 2 sections

Gateway components#

  • HTTP API with API key authentication. See System Setup and the API Reference.
  • GCS Bucket for uploads through signed URLs.
  • AI Validator on submit. After the uploaded files are verified, it compares the partner's source loan data with the underwriting guidelines and records a validation result for each loan.
  • AI Adaptor for origination mapping. It proposes how the partner's source fields map to Figure's standard model. Figure reviews and approves the mapping before production use.

Terminology#

Onboarding request. A collection of asset data (the loan tape) and metadata (the manifest) in one POST /api/onboard call to onboard loans on Provenance.

  • Every loan in the request uses the same file containing the underwriting guidelines, named in the manifest.
  • Every loan in the request is for a single asset holder (the originator on the API key unless originatorId is set on a loan).
  • Loans in the request may use more than one servicer (servicerId per loan).

Manifest. Metadata for all loans in the request:

  • Underwriting guidelines — the file named in manifest.underwritingGuidelines (one file for the whole request).
  • Partner Data Dictionary (optional) — may be sent as manifest.dataDictionary; see Partner Data Dictionary below.
  • Additional asset data — per loan: loan documents in manifest.loans[].files and values in manifest.loans[].data (such as servicerId) that are not columns in the loan tape.

Loan Tape. Origination fields, with your loan identifier in the column named by externalIdKey. Send a CSV file or a JSON array inline in the create body.

Underwriting Guidelines. One file for the request. PDF and JSON are both accepted. It contains the eligibility rules the loans were originated under.

Figure Data Dictionary. Figure's standard field names and descriptions for origination and servicing data on a given loanType. Figure provides the Figure Data Dictionary during System Setup. You can send the values using your source field names, not Figure's. Not every listed field is required on each loan or servicing row—include as many as you have.

Partner Data Dictionary. Partner's standard field names and descriptions for origination and servicing data on a given loanType. A common format is a CSV with the field name in the first column and the description in the second. For origination, you may optionally include it on the initial onboard request as manifest.dataDictionary. For servicing, you will share it with Figure offline during Servicing Data Requirements.

Loan Documents. Files attached to a single loan—the closing package and supporting documents—each with a documentType from the API Reference.