Skip to content
Docs

Asset Onboarding

Onboard third-party loans to Provenance with origination data, then keep them current with servicing tapes.

View as Markdown
On this page· 2 sections

Figure provides the Asset Onboarding Gateway so partners can onboard third-party assets to Provenance and transact across Figure Connect, Democratized Prime, and DART.

Partners can use the following endpoints to onboard their assets and provide servicing updates:

  1. Origination POST/api/onboard, Create an onboard request Loan tape, one file containing the underwriting guidelines for the request, and the loan documents (closing package and supporting files) for each loan.
  2. Servicing POST/api/servicing-tape, Upload a servicing tape A CSV of servicing updates for loans that are already onboarded.

System Setup is the checklist for Figure and partner requirements: platform access, Origination Data Requirements, and Servicing Data Requirements. Origination Data and Servicing Data describe the API payloads and files for each integration.

Contact Figure at capitalmarkets@figure.com to get started.

Origination#

Partners can send an onboard request to POST /api/onboard to onboard one or more loans using source loan origination data. Each loan is tokenized as an NFT on Provenance and available in the partner's account in Portfolio Manager.

Onboard loansRequestResponse or event
Your system
Onboarding Gateway
File storage
Provenance
Your system
Onboarding Gateway
File storage
Provenance
  1. 1
    Create an onboard request
    POST/api/onboard
    1

    Your systemtoOnboarding Gateway

    Create an onboard request
    POST/api/onboard
  2. 2
    Request ID and signed upload URLs
    2

    Onboarding GatewaytoYour system

    Request ID and signed upload URLs
  3. 3
    Upload the loan tape, underwriting guidelines, and loan documents
    3

    Your systemtoFile storage

    Upload the loan tape, underwriting guidelines, and loan documents
  4. 4
    Submit the request
    POST/api/onboard/{id}
    4

    Your systemtoOnboarding Gateway

    Submit the request
    POST/api/onboard/{id}
  5. 5
    Verify, validate, and transform
    5

    Onboarding Gateway

    Verify, validate, and transform
  6. 6
    Create an NFT for each loan
    6

    Onboarding GatewaytoProvenance

    Create an NFT for each loan
  7. LoopUntil the request is COMPLETED or FAILED
    1. 7

      Your systemtoOnboarding Gateway

      Check status
      GET/api/onboard/{id}/status

After you submit, the gateway does three things in step 5:

  1. Verifies files. Every file named in the manifest was uploaded.
  2. Validates. The AI Validator compares each loan's source origination data with the underwriting guidelines for that request and returns a validation result per loan.
  3. Transforms and creates NFTs. Figure applies the human-approved mapping from the AI Adaptor for your originator and loanType, then creates an NFT for each loan on Provenance.

Servicing#

Partners can send servicing updates for each onboarded loan by calling POST /api/servicing-tape.

Send servicing updatesRequestResponse or event
Your system
Onboarding Gateway
Provenance
Your system
Onboarding Gateway
Provenance
  1. 1
    Upload a servicing tape CSV
    POST/api/servicing-tape
    1

    Your systemtoOnboarding Gateway

    Upload a servicing tape CSV
    POST/api/servicing-tape
  2. 2
    Request ID
    2

    Onboarding GatewaytoYour system

    Request ID
  3. 3
    Transform your source data
    3

    Onboarding Gateway

    Transform your source data
  4. 4
    Save servicing updates
    4

    Onboarding GatewaytoProvenance

    Save servicing updates
  5. LoopUntil the request is COMPLETED or FAILED
    1. 5

      Your systemtoOnboarding Gateway

      Check status
      GET/api/servicing-tape/{id}

Partners send a CSV that matches the agreed servicing schema from Servicing Data Requirements. Figure applies that layout, then publishes updates so they are available on Provenance for loans that were already onboarded. Poll until the request status is COMPLETED or FAILED.