Step 4: List Application Values to Define Field Values

Run the ‘List Application Values’ method in order to view all the possible values for fields that do not support a free text input. This method can assist you in designing the application form with a predefined list of values for such fields and to allow only valid inputs for each of these fields.

Parameters

Request Header Parameters

- access_key
- Unique access key provided by Rapyd for each authorized user.
  See Developers.
- Content-Type
- Indicates that the data appears in JSON format. Set to application/json.
- idempotency
- A unique key that prevents the platform from creating the same object twice.
  See Idempotency.
- salt
- Random string. Recommended length: 8-16 characters.
- signature
- Signature calculated for each request individually.
  See Request Signatures.
- timestamp
- Timestamp for the request, in Unix time (seconds).
- api_timestamp
- Timestamp for the request, in Unix time (seconds).

Request Path Parameters

- app_token
- The application token identifier.

Response

Note

Due to the length of the response, in this example on the right side of the page, a shortened version of the response is displayed.

As an example, the address.us_state field displays the following valid values. Therefore, in the application form, it is recommended to create an HTML select/dropdown list accordingly:

JSON

  {
    "address": {
        "us_state": [
            {
                "id": "AL",
                "value": "Alabama"
            },
            {
                "id": "AK",
                "value": "Alaska"
            },
            {
                "id": "AZ",
                "value": "Arizona"
            },
            {
                "id": "AR",
                "value": "Arkansas"
            },
            {
                "id": "CA",
                "value": "California"
            },
            {
                "id": "CO",
                "value": "Colorado"
            },
            {
                "id": "CT",
                "value": "Connecticut"
            },
            {
                "id": "DE",
                "value": "Delaware"
            },
            {
                "id": "FL",
                "value": "Florida"
            },
            {
                "id": "GA",
                "value": "Georgia"
            },
            {
                "id": "HI",
                "value": "Hawaii"
            },
            {
                "id": "ID",
                "value": "Idaho"
            },
            {
                "id": "IL",
                "value": "Illinois"
            },
            {
                "id": "IN",
                "value": "Indiana"
            },
            {
                "id": "IA",
                "value": "Iowa"
            },
            {
                "id": "KS",
                "value": "Kansas"
            },
            {
                "id": "KY",
                "value": "Kentucky"
            },
            {
                "id": "LA",
                "value": "Louisiana"
            },
            {
                "id": "ME",
                "value": "Maine"
            },
            {
                "id": "MD",
                "value": "Maryland"
            },
            {
                "id": "MA",
                "value": "Massachusetts"
            },
            {
                "id": "MI",
                "value": "Michigan"
            },
            {
                "id": "MN",
                "value": "Minnesota"
            },
            {
                "id": "MS",
                "value": "Mississippi"
            },
            {
                "id": "MO",
                "value": "Missouri"
            },
            {
                "id": "MT",
                "value": "Montana"
            },
            {
                "id": "NE",
                "value": "Nebraska"
            },
            {
                "id": "NV",
                "value": "Nevada"
            },
            {
                "id": "NH",
                "value": "New Hampshire"
            },
            {
                "id": "NJ",
                "value": "New Jersey"
            },
            {
                "id": "NM",
                "value": "New Mexico"
            },
            {
                "id": "NY",
                "value": "New York"
            },
            {
                "id": "NC",
                "value": "North Carolina"
            },
            {
                "id": "ND",
                "value": "North Dakota"
            },
            {
                "id": "OH",
                "value": "Ohio"
            },
            {
                "id": "OK",
                "value": "Oklahoma"
            },
            {
                "id": "OR",
                "value": "Oregon"
            },
            {
                "id": "PA",
                "value": "Pennsylvania"
            },
            {
                "id": "RI",
                "value": "Rhode Island"
            },
            {
                "id": "SC",
                "value": "South Carolina"
            },
            {
                "id": "SD",
                "value": "South Dakota"
            },
            {
                "id": "TN",
                "value": "Tennessee"
            },
            {
                "id": "TX",
                "value": "Texas"
            },
            {
                "id": "UT",
                "value": "Utah"
            },
            {
                "id": "VT",
                "value": "Vermont"
            },
            {
                "id": "VA",
                "value": "Virginia"
            },
            {
                "id": "WA",
                "value": "Washington"
            },
            {
                "id": "WV",
                "value": "West Virginia"
            },
            {
                "id": "WI",
                "value": "Wisconsin"
            },
            {
                "id": "WY",
                "value": "Wyoming"
            }
        ]
    }
}
        

HTML

    
<select>
    <option value="AL">Alabama</option>
    <option value="AK">Alaska</option>
    <option value="AZ">Arizona</option>
    <option value="AR">Arkansas</option>
    <option value="CA">California</option>
    <option value="CO">Colorado</option>
    <option value="CT">Connecticut</option>
    <option value="DE">Delaware</option>
    <option value="DC">District Of Columbia</option>
    <option value="FL">Florida</option>
    <option value="GA">Georgia</option>
    <option value="HI">Hawaii</option>
    <option value="ID">Idaho</option>
    <option value="IL">Illinois</option>
    <option value="IN">Indiana</option>
    <option value="IA">Iowa</option>
    <option value="KS">Kansas</option>
    <option value="KY">Kentucky</option>
    <option value="LA">Louisiana</option>
    <option value="ME">Maine</option>
    <option value="MD">Maryland</option>
    <option value="MA">Massachusetts</option>
    <option value="MI">Michigan</option>
    <option value="MN">Minnesota</option>
    <option value="MS">Mississippi</option>
    <option value="MO">Missouri</option>
    <option value="MT">Montana</option>
    <option value="NE">Nebraska</option>
    <option value="NV">Nevada</option>
    <option value="NH">New Hampshire</option>
    <option value="NJ">New Jersey</option>
    <option value="NM">New Mexico</option>
    <option value="NY">New York</option>
    <option value="NC">North Carolina</option>
    <option value="ND">North Dakota</option>
    <option value="OH">Ohio</option>
    <option value="OK">Oklahoma</option>
    <option value="OR">Oregon</option>
    <option value="PA">Pennsylvania</option>
    <option value="RI">Rhode Island</option>
    <option value="SC">South Carolina</option>
    <option value="SD">South Dakota</option>
    <option value="TN">Tennessee</option>
    <option value="TX">Texas</option>
    <option value="UT">Utah</option>
    <option value="VT">Vermont</option>
    <option value="VA">Virginia</option>
    <option value="WA">Washington</option>
    <option value="WV">West Virginia</option>
    <option value="WI">Wisconsin</option>
    <option value="WY">Wyoming</option>
</select>

{base_uri}/verify/api/applications/list_of_values/:app_token

Create Application

curl -X GET
{base_uri}/verify/api/applications/list_of_values/app_991339c8fd9d477584505fe289053951
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'idempotency: your-idempotency-parameter-here'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'
-H 'api_timestamp: your-unix-timestamp-here'

 {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "20c788ac-142c-4838-a9d4-3a71e6ddac19"
        },
        "data": {
            "industry": {
                "business_industry": {
                    "Regulated and age-restricted products": [
                        {
                            "id": 5993,
                            "value": "Cigar Stores and Stands",
                            "sub_mcc": null
                        }
                    ]
                }
            }
        }
    }

In this section:

Documentation