For a deeper look into our World Check One API, look into:

Overview |  Quickstart |  Documentation |  Downloads

question

Upvotes
Accepted
35 11 18 20

What are the custom fields used for and where are the custom fields displayed​?

What’s the use of the customer-field tags like below, and where will those input info be shown?

{

"typeId": "{ {custom-field-1}}",

"value": "custom field 1 sample value"

}

world-checkworld-check-oneapiscreening
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

1 Answer

Upvote
Accepted
3.1k 16 7 7

Hi @John Williams

The custom-fields are free form text fields and can be setup to whatever the client wants to capture specific to cases. They are three default free text fields (Reference, Territory, & Primary Contact) that can be edited/deleted as needed.

Note: The custom fields are specific to a group, so that different groups may have different custom fields. From the API you can call the caseTemplate method in the groups web service and get the customized fields for a specific group.

GET { {protocol}}{ {gateway-host}}{ {gateway-url}}groups/{ {group-id}}/caseTemplate

Let me know if you have any more API questions.

icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.