Skip to content
Docs

Asset Onboarding/Onboarding

Retrieve update status

GET/api/onboard/updates/{id}
API key required
Request
curl -X GET \
  "https://api.test.figure.com/gateway-asset-onboarding/partner/api/onboard/updates/{id}" \
  -H "apikey: $FIGURE_API_KEY"

Path parameters

  • idstring<uuid>Required

Responses

200OKobject

  • updateRequestIdstring<uuid>Required

    UUID of the update. Required later to submit or check status

  • namestringRequired
  • statusenumRequired
    One ofAwaitingUploadSubmittedTransformedCompletedRejected
  • uploadUrlsmap of string<url>Required

    Map of file names to signed URLs for upload, covering the loan tape when it is a file and every document being added. Empty once there is nothing left to stage

  • requestsarray of objectsRequired

    The child onboarding requests this update fanned out into

    ShowHide 3 attributes of requests
    • requestIdstring<uuid>Required
    • namestringRequired
    • sourceRequestIdstring<uuid>Required

      The prior request this child inherits its manifest from

  • loansarray of objectsRequired
    ShowHide 5 attributes of loans
    • idstringRequired

      Third-party loan identifier

    • overwrittenFilesarray of stringsRequired

      Documents replaced by a same-name document in this update. The prior document is invalidated, so this is called out rather than left for the client to infer

    • figureIdstring<uuid>

      Figure internal loan identifier, absent when the loan was rejected

    • requestIdstring<uuid>

      The child request this loan was placed into, absent when rejected

    • errorstring

      Why this loan could not be updated, when it was rejected

  • nextActionenumRequired

    What the caller should do next based on this response

    One ofUpload the requested files, then submit the update.Monitor child request progress by polling the update status.Retry the update after the dependent onboarding request or transient issue is resolved.Fix the reported issues and submit a new update.Do not retry automatically; manual intervention is required, please reach out to the Figure team for assistance.
  • errorsarray of strings

    Any update-level errors. Example: the loan tape file is missing

400Bad Requestobject
  • messagestringRequired
403Forbiddenobject
  • messagestringRequired
404Not Foundobject
  • messagestringRequired
422Unprocessable Entityobject
  • messagestringRequired
500Internal Server Errorobject
  • messagestringRequired
Response
{
  "updateRequestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "name": "string",
  "status": "AwaitingUpload",
  "uploadUrls": {
    "key": "https://example.com"
  },
  "requests": [
    {
      "requestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "name": "string",
      "sourceRequestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a"
    }
  ],
  "loans": [
    {
      "id": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "figureId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "requestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "overwrittenFiles": [
        "string"
      ],
      "error": "string"
    }
  ],
  "errors": [
    "string"
  ],
  "nextAction": "Upload the requested files, then submit the update."
}