Validate a alert
curl --request POST \
--url https://api.artu.ai/alerts/{alertId}/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"defaults": {
"scopeData": {
"MX": {
"cnbv": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"TRANSMISOR": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"sucursal": "<string>",
"agenteNombre": "<string>",
"agenteApellidoPaterno": "<string>",
"agenteApellidoMaterno": "<string>",
"agenteRfc": "<string>",
"agenteCurp": "<string>"
}
}
}
}
}
}
'import requests
url = "https://api.artu.ai/alerts/{alertId}/validate"
payload = { "defaults": { "scopeData": { "MX": { "cnbv": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"TRANSMISOR": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"sucursal": "<string>",
"agenteNombre": "<string>",
"agenteApellidoPaterno": "<string>",
"agenteApellidoMaterno": "<string>",
"agenteRfc": "<string>",
"agenteCurp": "<string>"
}
} } } } }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
defaults: {
scopeData: {
MX: {
cnbv: {
organoSupervisor: '<string>',
claveSujetoObligado: '<string>',
TRANSMISOR: {
organoSupervisor: '<string>',
claveSujetoObligado: '<string>',
sucursal: '<string>',
agenteNombre: '<string>',
agenteApellidoPaterno: '<string>',
agenteApellidoMaterno: '<string>',
agenteRfc: '<string>',
agenteCurp: '<string>'
}
}
}
}
}
})
};
fetch('https://api.artu.ai/alerts/{alertId}/validate', 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.artu.ai/alerts/{alertId}/validate",
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([
'defaults' => [
'scopeData' => [
'MX' => [
'cnbv' => [
'organoSupervisor' => '<string>',
'claveSujetoObligado' => '<string>',
'TRANSMISOR' => [
'organoSupervisor' => '<string>',
'claveSujetoObligado' => '<string>',
'sucursal' => '<string>',
'agenteNombre' => '<string>',
'agenteApellidoPaterno' => '<string>',
'agenteApellidoMaterno' => '<string>',
'agenteRfc' => '<string>',
'agenteCurp' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <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://api.artu.ai/alerts/{alertId}/validate"
payload := strings.NewReader("{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<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://api.artu.ai/alerts/{alertId}/validate")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/alerts/{alertId}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": {
"totalItems": 4503599627370495,
"validItems": 4503599627370495,
"invalidItems": 4503599627370495,
"errorCount": 4503599627370495
},
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>",
"severity": "error",
"resource": "alert",
"resourceId": "<string>",
"itemId": "<string>",
"label": "<string>",
"sdkField": "<string>",
"parentClientId": "<string>"
}
]
}Alerts
Validate a alert
POST
/
alerts
/
{alertId}
/
validate
Validate a alert
curl --request POST \
--url https://api.artu.ai/alerts/{alertId}/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"defaults": {
"scopeData": {
"MX": {
"cnbv": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"TRANSMISOR": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"sucursal": "<string>",
"agenteNombre": "<string>",
"agenteApellidoPaterno": "<string>",
"agenteApellidoMaterno": "<string>",
"agenteRfc": "<string>",
"agenteCurp": "<string>"
}
}
}
}
}
}
'import requests
url = "https://api.artu.ai/alerts/{alertId}/validate"
payload = { "defaults": { "scopeData": { "MX": { "cnbv": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"TRANSMISOR": {
"organoSupervisor": "<string>",
"claveSujetoObligado": "<string>",
"sucursal": "<string>",
"agenteNombre": "<string>",
"agenteApellidoPaterno": "<string>",
"agenteApellidoMaterno": "<string>",
"agenteRfc": "<string>",
"agenteCurp": "<string>"
}
} } } } }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
defaults: {
scopeData: {
MX: {
cnbv: {
organoSupervisor: '<string>',
claveSujetoObligado: '<string>',
TRANSMISOR: {
organoSupervisor: '<string>',
claveSujetoObligado: '<string>',
sucursal: '<string>',
agenteNombre: '<string>',
agenteApellidoPaterno: '<string>',
agenteApellidoMaterno: '<string>',
agenteRfc: '<string>',
agenteCurp: '<string>'
}
}
}
}
}
})
};
fetch('https://api.artu.ai/alerts/{alertId}/validate', 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.artu.ai/alerts/{alertId}/validate",
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([
'defaults' => [
'scopeData' => [
'MX' => [
'cnbv' => [
'organoSupervisor' => '<string>',
'claveSujetoObligado' => '<string>',
'TRANSMISOR' => [
'organoSupervisor' => '<string>',
'claveSujetoObligado' => '<string>',
'sucursal' => '<string>',
'agenteNombre' => '<string>',
'agenteApellidoPaterno' => '<string>',
'agenteApellidoMaterno' => '<string>',
'agenteRfc' => '<string>',
'agenteCurp' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <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://api.artu.ai/alerts/{alertId}/validate"
payload := strings.NewReader("{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<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://api.artu.ai/alerts/{alertId}/validate")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/alerts/{alertId}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"defaults\": {\n \"scopeData\": {\n \"MX\": {\n \"cnbv\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"TRANSMISOR\": {\n \"organoSupervisor\": \"<string>\",\n \"claveSujetoObligado\": \"<string>\",\n \"sucursal\": \"<string>\",\n \"agenteNombre\": \"<string>\",\n \"agenteApellidoPaterno\": \"<string>\",\n \"agenteApellidoMaterno\": \"<string>\",\n \"agenteRfc\": \"<string>\",\n \"agenteCurp\": \"<string>\"\n }\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"summary": {
"totalItems": 4503599627370495,
"validItems": 4503599627370495,
"invalidItems": 4503599627370495,
"errorCount": 4503599627370495
},
"errors": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>",
"severity": "error",
"resource": "alert",
"resourceId": "<string>",
"itemId": "<string>",
"label": "<string>",
"sdkField": "<string>",
"parentClientId": "<string>"
}
]
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Path Parameters
Body
application/json
Available options:
mex.actividad-vulnerable.ari, mex.actividad-vulnerable.avi, mex.actividad-vulnerable.inm, mex.actividad-vulnerable.jys, mex.actividad-vulnerable.mjr, mex.actividad-vulnerable.mpc, mex.actividad-vulnerable.tsc, mex.actividad-vulnerable.veh, mex.cnbv.transmisor Show child attributes
Show child attributes
Was this page helpful?
