Skip to content
Docs

HELOC Inquiries/Encryption

Create a payload request

POST/encryption/v1/payload-requests
API key required
Request
curl -X POST \
  "https://api.test.figure.com/encryption/v1/payload-requests" \
  -H "apikey: $FIGURE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "payloadType": "HELOC_APPLICATION",
  "payload": null,
  "loanOriginatorUuid": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a"
}'

Request body

application/json
  • payloadTypeenumRequired
    One ofHELOC_APPLICATIONHELOC_INQUIRY
  • payloadanyRequired
  • loanOriginatorUuidstring<uuid>

    Optional. Only needed when the payload type does not carry a loan originator, or to explicitly state which loan originator the payload belongs to (e.g. HELOC_INQUIRY). When the payload already carries a loan originator, the two must match.

Responses

200OKobject
  • redirectUrlstringRequired
  • requestPayloadUuidstring<uuid>Required
  • expiresAtstring<date-time>Required
Response
{
  "redirectUrl": "string",
  "requestPayloadUuid": "3f2b6c1e-8d4a-4b7e-9c2f-5a1d7e9b0c3a",
  "expiresAt": "2026-01-15T14:30:00Z"
}