Start or submit a KYC verification flow

curl --request POST \
  --url https://monitor.aevr.space/api/v1/payid/kyc/verify \
  --header 'Content-Type: application/json' \
  --header 'auth-token: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "dateOfBirth": "2023-12-25",
  "country": "<string>",
  "identityNumbers": {},
  "gender": "<string>",
  "address": {
    "street": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  }
}
'

import requests

url = "https://monitor.aevr.space/api/v1/payid/kyc/verify"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "dateOfBirth": "2023-12-25",
    "country": "<string>",
    "identityNumbers": {},
    "gender": "<string>",
    "address": {
        "street": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
    }
}
headers = {
    "auth-token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'auth-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    phone: '<string>',
    dateOfBirth: '2023-12-25',
    country: '<string>',
    identityNumbers: {},
    gender: '<string>',
    address: {
      street: '<string>',
      street2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>',
      country: '<string>'
    }
  })
};

fetch('https://monitor.aevr.space/api/v1/payid/kyc/verify', 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://monitor.aevr.space/api/v1/payid/kyc/verify",
  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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'dateOfBirth' => '2023-12-25',
    'country' => '<string>',
    'identityNumbers' => [
        
    ],
    'gender' => '<string>',
    'address' => [
        'street' => '<string>',
        'street2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>',
        'country' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "auth-token: <api-key>"
  ],
]);

$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://monitor.aevr.space/api/v1/payid/kyc/verify"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}")

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

	req.Header.Add("auth-token", "<api-key>")
	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://monitor.aevr.space/api/v1/payid/kyc/verify")
  .header("auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://monitor.aevr.space/api/v1/payid/kyc/verify")

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

request = Net::HTTP::Post.new(url)
request["auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

POST

api

payid

kyc

verify

Start or submit a KYC verification flow

curl --request POST \
  --url https://monitor.aevr.space/api/v1/payid/kyc/verify \
  --header 'Content-Type: application/json' \
  --header 'auth-token: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "dateOfBirth": "2023-12-25",
  "country": "<string>",
  "identityNumbers": {},
  "gender": "<string>",
  "address": {
    "street": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  }
}
'

import requests

url = "https://monitor.aevr.space/api/v1/payid/kyc/verify"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "dateOfBirth": "2023-12-25",
    "country": "<string>",
    "identityNumbers": {},
    "gender": "<string>",
    "address": {
        "street": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
    }
}
headers = {
    "auth-token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'auth-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    phone: '<string>',
    dateOfBirth: '2023-12-25',
    country: '<string>',
    identityNumbers: {},
    gender: '<string>',
    address: {
      street: '<string>',
      street2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>',
      country: '<string>'
    }
  })
};

fetch('https://monitor.aevr.space/api/v1/payid/kyc/verify', 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://monitor.aevr.space/api/v1/payid/kyc/verify",
  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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'phone' => '<string>',
    'dateOfBirth' => '2023-12-25',
    'country' => '<string>',
    'identityNumbers' => [
        
    ],
    'gender' => '<string>',
    'address' => [
        'street' => '<string>',
        'street2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>',
        'country' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "auth-token: <api-key>"
  ],
]);

$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://monitor.aevr.space/api/v1/payid/kyc/verify"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}")

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

	req.Header.Add("auth-token", "<api-key>")
	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://monitor.aevr.space/api/v1/payid/kyc/verify")
  .header("auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://monitor.aevr.space/api/v1/payid/kyc/verify")

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

request = Net::HTTP::Post.new(url)
request["auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"country\": \"<string>\",\n  \"identityNumbers\": {},\n  \"gender\": \"<string>\",\n  \"address\": {\n    \"street\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

Authorizations

auth-token

string

header

required

Header-based auth used by PayID integration routes.

Body

application/json

firstName

string

required

lastName

string

required

string<email>

required

phone

string

required

dateOfBirth

string<date>

required

country

string

required

identityNumbers

object

required

Show child attributes

gender

string

address

object

Show child attributes

Response

Verification initiated

System

Auth

Alert Channels

API Keys

Organizations

Incidents

Invites

Members

Monitors

Status Page

Status Pages

PayID

User

Badges

Start or submit a KYC verification flow

Authorizations

Body

Response