SmartSearch - Run a UKAML Check

POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run
Personal access token & O auth2

Headers

Path parameters

application/json

Body Required

  • attributes array[string] Required

    The attributes to be sent
POST /api/v1/addons/smartsearch/ukaml/{client_uuid}/run 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/addons/smartsearch/ukaml/client_uuid/run' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"attributes":[{"bank":{"sortcode":"01-02-03","roll_number":"A/123456789-Z","account_type":"direct_debit","account_number":"123456789"},"addresses":[{"flat":"Flat 1","town":"Ilkley","region":"West Yorkshire","building":"Mayfield House","duration":3,"postcode":"LS208BX","street_1":"Lower Railway Road","street_2":null}],"documents":{"passport":{"expiry":"2020-20-12","country":"GBR","mrz_line_2":"3785333651GBR6210283M1601013\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c\u003c02"},"driving_licence":{"number":"JUDD9507139NP9LN"},"national_insurance":"GBR"}}]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "attributes": [
    {
      "bank": {
        "sortcode": "01-02-03",
        "roll_number": "A/123456789-Z",
        "account_type": "direct_debit",
        "account_number": "123456789"
      },
      "addresses": [
        {
          "flat": "Flat 1",
          "town": "Ilkley",
          "region": "West Yorkshire",
          "building": "Mayfield House",
          "duration": 3,
          "postcode": "LS208BX",
          "street_1": "Lower Railway Road",
          "street_2": null
        }
      ],
      "documents": {
        "passport": {
          "expiry": "2020-20-12",
          "country": "GBR",
          "mrz_line_2": "3785333651GBR6210283M1601013<<<<<<<<<<<<<<02"
        },
        "driving_licence": {
          "number": "JUDD9507139NP9LN"
        },
        "national_insurance": "GBR"
      }
    }
  ]
}