Update metadata on an onboarding

PUT

/v2/onboarding/:external_id/metadata/

PUT

/v2/onboarding/:external_id/metadata/

curl -X PUT https://api.upwardli.com/v2/onboarding/external_id/metadata/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "metadata": {}
}'

{
  "id": "string",
  "status": "string",
  "consumer": {
    "id": "string",
    "pcid": "string",
    "mla_status": true,
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "is_active": true,
    "kyc_status": "string",
    "phone_number": "string",
    "date_of_birth": "string",
    "tax_id_type": "string",
    "tax_identifier": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_zip": "string",
    "credit_lines": "string"
  },
  "kyc": {
    "inquiry_ids": [
      "string"
    ],
    "fallback_inquiry_id": "string",
    "inquiry_template_id": "string",
    "errors": "string"
  },
  "e_sign": {
    "agreement_accepted": true,
    "agreement_accepted_date": "2024-01-15T09:30:00Z"
  },
  "underwriting": {
    "result": "string",
    "data": "string",
    "errors": [
      null
    ]
  },
  "product": {
    "product_id": "string",
    "product_configuration": {}
  },
  "previous_steps": [
    {
      "slug": "string",
      "url": "string"
    }
  ],
  "current_steps": [
    {
      "slug": "string",
      "url": "string"
    }
  ],
  "metadata": {}
}

Merges key/value pairs into the onboarding object’s metadata. Keys already present are overwritten; keys you leave out are kept. Also accepts the reserved autopay_enabled key to set the consumer’s autopay election.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

Request

This endpoint expects an object.

metadataobject or nullRequired

A free-form object of key/value pairs stored on the onboarding object. Keys you define are stored and returned untouched. autopay_enabled is reserved: send it as a JSON boolean to set whether the consumer’s account automatically pays its balance each cycle. The key is matched case-insensitively. It defaults to true. A quoted string such as "false" is stored as ordinary metadata and does not change the autopay setting. Send the election before submitting the loan.

Response

idstringformat: "uuid"

statusstring

consumerobject

kycobject

e_signobject

underwritingobject

productobject

previous_stepslist of objects

current_stepslist of objects or null

metadataobject or null

Errors

409

Conflict Error