Create a document
curl --request POST \
--url https://api.artu.ai/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "MX",
"type": "ine_front",
"expiresAt": "2023-12-25",
"externalId": "<string>",
"metadata": {},
"fields": {
"claveElector": "<string>",
"curp": "<string>",
"fullName": "<string>",
"paternalSurname": "<string>",
"maternalSurname": "<string>",
"givenNames": "<string>",
"dateOfBirth": "2023-12-25",
"birthState": "<string>",
"street": "<string>",
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"state": "<string>",
"postalCode": "<string>",
"section": "<string>",
"registrationYear": 2000,
"issueYear": 2000,
"expirationYear": 2000
}
}
'import requests
url = "https://api.artu.ai/documents"
payload = {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "MX",
"type": "ine_front",
"expiresAt": "2023-12-25",
"externalId": "<string>",
"metadata": {},
"fields": {
"claveElector": "<string>",
"curp": "<string>",
"fullName": "<string>",
"paternalSurname": "<string>",
"maternalSurname": "<string>",
"givenNames": "<string>",
"dateOfBirth": "2023-12-25",
"birthState": "<string>",
"street": "<string>",
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"state": "<string>",
"postalCode": "<string>",
"section": "<string>",
"registrationYear": 2000,
"issueYear": 2000,
"expirationYear": 2000
}
}
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({
clientId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: 'MX',
type: 'ine_front',
expiresAt: '2023-12-25',
externalId: '<string>',
metadata: {},
fields: {
claveElector: '<string>',
curp: '<string>',
fullName: '<string>',
paternalSurname: '<string>',
maternalSurname: '<string>',
givenNames: '<string>',
dateOfBirth: '2023-12-25',
birthState: '<string>',
street: '<string>',
exteriorNumber: '<string>',
interiorNumber: '<string>',
neighborhood: '<string>',
municipality: '<string>',
state: '<string>',
postalCode: '<string>',
section: '<string>',
registrationYear: 2000,
issueYear: 2000,
expirationYear: 2000
}
})
};
fetch('https://api.artu.ai/documents', 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/documents",
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([
'clientId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => 'MX',
'type' => 'ine_front',
'expiresAt' => '2023-12-25',
'externalId' => '<string>',
'metadata' => [
],
'fields' => [
'claveElector' => '<string>',
'curp' => '<string>',
'fullName' => '<string>',
'paternalSurname' => '<string>',
'maternalSurname' => '<string>',
'givenNames' => '<string>',
'dateOfBirth' => '2023-12-25',
'birthState' => '<string>',
'street' => '<string>',
'exteriorNumber' => '<string>',
'interiorNumber' => '<string>',
'neighborhood' => '<string>',
'municipality' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'section' => '<string>',
'registrationYear' => 2000,
'issueYear' => 2000,
'expirationYear' => 2000
]
]),
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/documents"
payload := strings.NewReader("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\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/documents")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/documents")
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 \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\n }\n}"
response = http.request(request)
puts response.read_body{
"document": {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "identity",
"scope": "MX",
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "pending_upload",
"filename": "<string>",
"contentType": "<string>",
"size": 0,
"expiresAt": "2023-12-25",
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": "<string>",
"rejectionReason": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewedBy": "<string>",
"externalId": "<string>",
"fields": {},
"metadata": {}
},
"upload": {
"url": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
}Documents
Create a document
POST
/
documents
Create a document
curl --request POST \
--url https://api.artu.ai/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "MX",
"type": "ine_front",
"expiresAt": "2023-12-25",
"externalId": "<string>",
"metadata": {},
"fields": {
"claveElector": "<string>",
"curp": "<string>",
"fullName": "<string>",
"paternalSurname": "<string>",
"maternalSurname": "<string>",
"givenNames": "<string>",
"dateOfBirth": "2023-12-25",
"birthState": "<string>",
"street": "<string>",
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"state": "<string>",
"postalCode": "<string>",
"section": "<string>",
"registrationYear": 2000,
"issueYear": 2000,
"expirationYear": 2000
}
}
'import requests
url = "https://api.artu.ai/documents"
payload = {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "MX",
"type": "ine_front",
"expiresAt": "2023-12-25",
"externalId": "<string>",
"metadata": {},
"fields": {
"claveElector": "<string>",
"curp": "<string>",
"fullName": "<string>",
"paternalSurname": "<string>",
"maternalSurname": "<string>",
"givenNames": "<string>",
"dateOfBirth": "2023-12-25",
"birthState": "<string>",
"street": "<string>",
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"state": "<string>",
"postalCode": "<string>",
"section": "<string>",
"registrationYear": 2000,
"issueYear": 2000,
"expirationYear": 2000
}
}
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({
clientId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: 'MX',
type: 'ine_front',
expiresAt: '2023-12-25',
externalId: '<string>',
metadata: {},
fields: {
claveElector: '<string>',
curp: '<string>',
fullName: '<string>',
paternalSurname: '<string>',
maternalSurname: '<string>',
givenNames: '<string>',
dateOfBirth: '2023-12-25',
birthState: '<string>',
street: '<string>',
exteriorNumber: '<string>',
interiorNumber: '<string>',
neighborhood: '<string>',
municipality: '<string>',
state: '<string>',
postalCode: '<string>',
section: '<string>',
registrationYear: 2000,
issueYear: 2000,
expirationYear: 2000
}
})
};
fetch('https://api.artu.ai/documents', 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/documents",
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([
'clientId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => 'MX',
'type' => 'ine_front',
'expiresAt' => '2023-12-25',
'externalId' => '<string>',
'metadata' => [
],
'fields' => [
'claveElector' => '<string>',
'curp' => '<string>',
'fullName' => '<string>',
'paternalSurname' => '<string>',
'maternalSurname' => '<string>',
'givenNames' => '<string>',
'dateOfBirth' => '2023-12-25',
'birthState' => '<string>',
'street' => '<string>',
'exteriorNumber' => '<string>',
'interiorNumber' => '<string>',
'neighborhood' => '<string>',
'municipality' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'section' => '<string>',
'registrationYear' => 2000,
'issueYear' => 2000,
'expirationYear' => 2000
]
]),
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/documents"
payload := strings.NewReader("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\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/documents")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/documents")
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 \"clientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": \"MX\",\n \"type\": \"ine_front\",\n \"expiresAt\": \"2023-12-25\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"fields\": {\n \"claveElector\": \"<string>\",\n \"curp\": \"<string>\",\n \"fullName\": \"<string>\",\n \"paternalSurname\": \"<string>\",\n \"maternalSurname\": \"<string>\",\n \"givenNames\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"birthState\": \"<string>\",\n \"street\": \"<string>\",\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"section\": \"<string>\",\n \"registrationYear\": 2000,\n \"issueYear\": 2000,\n \"expirationYear\": 2000\n }\n}"
response = http.request(request)
puts response.read_body{
"document": {
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "identity",
"scope": "MX",
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "pending_upload",
"filename": "<string>",
"contentType": "<string>",
"size": 0,
"expiresAt": "2023-12-25",
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": "<string>",
"rejectionReason": "<string>",
"reviewedAt": "2023-11-07T05:31:56Z",
"reviewedBy": "<string>",
"externalId": "<string>",
"fields": {},
"metadata": {}
},
"upload": {
"url": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
Client ID
Content Type
Available options:
image/jpeg, image/png, image/webp, application/pdf Category
Available options:
identity, tax, address, incorporation, financial, other, consent Expires At
External ID
Metadata
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?