Skip to main content

System Details

Gateway Components​

  • HTTP API with API key authentication (See Setup and OpenAPI Spec)
  • GCS Bucket for file uploads via Signed URLs
  • Coming soon: UW Guidelines Validator
  • Data Transformers: Transform source data to Figure's standard data models

Terminology​

Onboarding request: A collection of asset data (loan tape) and metadata (manifest) to onboard to Provenance

  • All assets in request will use the same UW guidelines specified in manifest
  • All assets in request will be for a single asset holder
  • Assets in request can be from more than one servicer

Loan tape: Asset data that includes a unique external identifier provided as key-values in a request payload or CSV file

Manifest: Asset metadata for all assets in the request:

  • UW guidelines: File with underwriting guidelines
  • (Optional) Data dictionary: Descriptions of fields in loan tape
  • Additonal asset data: Associated files per asset and additional data (e.g. servicerId) not in loan tape