Skip to main content
POST
/
customers
/
{id}
/
verifications
Start a verification
curl --request POST \
  --url https://api.lumx.io/customers/{id}/verifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedPartyIds": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}
'
import requests

url = "https://api.lumx.io/customers/{id}/verifications"

payload = { "associatedPartyIds": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({associatedPartyIds: ['a1b2c3d4-e5f6-7890-abcd-ef1234567890']})
};

fetch('https://api.lumx.io/customers/{id}/verifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lumx.io/customers/{id}/verifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'associatedPartyIds' => [
        'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lumx.io/customers/{id}/verifications"

	payload := strings.NewReader("{\n  \"associatedPartyIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.lumx.io/customers/{id}/verifications")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"associatedPartyIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/customers/{id}/verifications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"associatedPartyIds\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Path Parameters

id
string<uuid>
required

Customer's unique identifier.

Body

application/json
associatedPartyIds
string<uuid>[]

Optional list of associated party IDs to retry verification for, in isolation. When provided, only these associated parties are sent for verification again; the customer's overall verification is not restarted. Applies only to BUSINESS customers.

Response

201 - application/json

Verification successfully started.

id
string<uuid>

Verification's unique identifier.