Skip to content
Docs

Asset Onboarding/Onboarding

Retrieve loan status

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

Path parameters

  • idstringRequired

    External ID (String) or Figure ID (UUID)

Responses

200OKmap of object

A map of keys to objects with:

  • idstringRequired

    Third-party loan identifier

  • figureIdstring<uuid>Required

    Figure internal loan identifier

  • errorsarray of strings

    Any loan specific errors. Example: Missing a file declared in manifest

  • transformedAtstring<date-time>
  • losStatusenum
    One ofREQUESTEDSUCCESSIN_RETRYFAILURE
400Bad Requestobject
  • messagestringRequired
403Forbiddenobject
  • messagestringRequired
404Not Foundobject
  • messagestringRequired
422Unprocessable Entityobject
  • messagestringRequired
500Internal Server Errorobject
  • messagestringRequired
Response
{
  "key": {
    "id": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
    "figureId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
    "errors": [
      "string"
    ],
    "transformedAt": "2026-01-15T14:30:00Z",
    "losStatus": "REQUESTED"
  }
}