VIP UDF

Query and manage (add/update/remove) VIP UDF data. Only UDFs that are of type ALPHA-NUMERIC may be added to the VIP list.

Endpoints

/rpc/v1/vip/udf.html: The browsable documentation for this API endpoint.
/rpc/v1/vip/udf.json: Endpoint that will return a JSON response.
/rpc/v1/vip/udf.xml: Endpoint that will return an XML response.

Usage

Usage for HTTP GET

Key Name: udf: UDF to look up in the VIP list.

The status code (review, decline, etc) will be returned.
Example: udf[LABEL]=VALUE

Usage for HTTP POST

Key Name: (a|r|e|d|x)_udf[][]
a=approve, r=review, e=escalate, d=decline, x=delete: First brackets contain a UDF label. Value is the UDF value.

Must provide at least one udf with a valid label and value.
Examples:
a_udf[LABEL][]=VALUE
r_udf[LABEL][]=VALUE
e_udf[LABEL][]=VALUE
d_udf[LABEL][]=VALUE
x_udf[LABEL][]=VALUE

Error Codes

206 Partial Success: In batch requests, this signifies that there were a mix of successes and failures.
400 Validation: Incorrect/Invalid input data.
401 Authentication: The key provided could not be authenticated

Response Samples

Successful Response: GET [XML]

<?xml version="1.0" encoding="UTF-8"?>
<response>
 <status>ok</status>
 <count>
  <success>1</success>
  <failure>0</failure>
 </count>
 <errors/>
 <result>decline</result>
</response>

Successful Response: GET [JSON]

{"status":"ok","count":{"success":1,"failure":0},"errors":[],"result":"decline"}

Code Examples

GET

curl -G \
   -d "udf[LABEL]=VALUE" \
   -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
   https://api.kount.net/rpc/v1/vip/udf.json

POST

curl -d "r_udf[LABEL][]=VALUE" \
     -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
     https://api.kount.net/rpc/v1/vip/udf.json

POST (batch)

curl -d "r_udf[LABEL][]=VALUE" \
     -d "d_udf[LABEL][]=VALUE" \
     -H "X-Kount-Api-Key: XXX.YYY.ZZZ" \
     https://api.kount.net/rpc/v1/vip/udf.json