Skip to content
Docs

Asset Onboarding/Onboarding

Submit an onboard request

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

Path parameters

  • idstringRequired

    Request name (String) or ID (UUID)

Responses

200OKobject

  • requestIdstring<uuid>Required
  • namestringRequired
  • loansarray of objectsRequired
    ShowHide 5 attributes of loans
    • 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
  • statusenumRequired
    One ofCreatedSubmittedTransformedCompletedFailed
  • errorsarray of strings

    Any root-level request errors. Example: Missing a file declared in manifest

400Bad Requestobject
  • messagestringRequired
403Forbiddenobject
  • messagestringRequired
404Not Foundobject
  • messagestringRequired
422Unprocessable Entityobject
  • messagestringRequired
500Internal Server Errorobject
  • messagestringRequired
Response
{
  "requestId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "name": "string",
  "loans": [
    {
      "id": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "figureId": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
      "errors": [
        "string"
      ],
      "transformedAt": "2026-01-15T14:30:00Z",
      "losStatus": "REQUESTED"
    }
  ],
  "status": "Created",
  "errors": [
    "string"
  ]
}