UPP Docs
Reference

List options for a dropdown field

GET
/requirements/{requirementId}/fields/{field}/options

The URL is the options_url in the card product's cardholder_fields. Fixed options are returned as-is; dictionary fields return only enabled values that the requirement's provider supports. When the field has a parent field (parent_field), pass the parent's value as a query parameter named after the parent field (such as ?country=JP); without it the list is empty.

Authorization

merchantApiKeymerchantTimestampmerchantNoncemerchantSignature
headerX-API-KEY<token>

Merchant API key (starts with upk_, also accepts api-key); signing headers are also required

headerX-Timestamp<token>

Unix timestamp in seconds, within 300 seconds of server time

headerX-Nonce<token>

Unique per request; cannot be reused with the same credential during the timestamp validity window

headerX-Signature<token>

Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest

Path Parameters

requirementId*string
field*string

Response Body

Options

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://sandbox.getupp.net/api/v1/requirements/rqs_01m5xsrnexe3wd4etjpvk8cy5m/fields/town/options'
Example Response
{  "data": [    {      "value": "tokyo",      "label": "Tokyo"    },    {      "value": "osaka",      "label": "Osaka"    }  ]}