Skip to main content
GET
/
products
/
{id}
Retrieve a product by ID
curl --request GET \
  --url https://api.artu.ai/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Environment: <api-key>'
{
  "name": "<string>",
  "scopes": [],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "externalId": "<string>",
  "metadata": {},
  "scopeData": {
    "MX": {
      "actividadVulnerable": {
        "ARI": {
          "operationType": "1501",
          "property": {
            "value": "<string>",
            "calle": "<string>",
            "colonia": "<string>",
            "numeroExterior": "<string>",
            "postalCode": "<string>",
            "folioReal": "<string>"
          }
        },
        "AVI": {
          "operationType": "<unknown>",
          "cryptoCurrency": "<string>"
        },
        "INM": {
          "operationType": "501",
          "inmuebles": [
            {
              "value": "<string>",
              "calle": "<string>",
              "colonia": "<string>",
              "numeroExterior": "<string>",
              "numeroInterior": "<string>",
              "postalCode": "<string>",
              "dimensionTerreno": "<string>",
              "dimensionConstruido": "<string>",
              "folioReal": "<string>"
            }
          ],
          "payments": [
            {}
          ]
        },
        "JYS": {
          "settlementType": "<unknown>",
          "branchInformation": {
            "type": "<unknown>",
            "postalCode": "<string>"
          }
        },
        "MJR": {
          "operationPostalCode": "<string>",
          "goods": [
            {
              "quantity": "<string>"
            }
          ],
          "paymentDefaults": [
            {}
          ]
        },
        "MPC": {
          "defaultCollateral": {
            "postalCode": "<string>"
          }
        },
        "TSC": {
          "operationType": "211"
        },
        "VEH": {
          "vehicles": [
            {
              "kind": "<unknown>",
              "marcaFabricante": "<string>",
              "modelo": "<string>",
              "anio": "<string>",
              "vin": "<string>",
              "repuve": "<string>",
              "placas": "<string>"
            }
          ]
        }
      },
      "cnbv": {
        "TRANSMISOR": {
          "sucursal": "<string>"
        }
      }
    }
  },
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

id
string<uuid>
required

Query Parameters

requireScope
enum<string>[]
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX

Response

200 - application/json

OK

name
string
required

Name

Required string length: 1 - 255
scopes
enum<string>[]
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
id
string<uuid>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string

Description

Maximum string length: 1000
externalId
string

External ID

metadata
object

Metadata

scopeData
object
tags
object[]