Skip to main content
PUT
/
clients
/
batch
/
external
Create or update multiple clients by external ID
curl --request PUT \
  --url https://api.artu.ai/clients/batch/external \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "items": [
    {
      "type": "<unknown>",
      "name": "<string>",
      "externalId": "<string>",
      "scopes": [],
      "nationalities": "<string>",
      "metadata": {},
      "birthDate": "2023-12-25",
      "middleName": "<string>",
      "lastName": "<string>",
      "scopeData": {
        "MX": {
          "rfc": "<string>",
          "curp": "<string>",
          "actividadVulnerable": {
            "ARI": {},
            "AVI": {
              "username": "<string>"
            },
            "INM": {},
            "JYS": {},
            "MJR": {},
            "MPC": {},
            "TSC": {},
            "VEH": {}
          },
          "cnbv": {
            "TRANSMISOR": {
              "numeroCuenta": "<string>",
              "claveSujetoObligado": "<string>"
            }
          }
        },
        "US": "<unknown>"
      }
    }
  ],
  "atomic": true
}
'
{
  "atomic": "<unknown>",
  "data": [
    {
      "data": {
        "type": "<unknown>",
        "name": "<string>",
        "scopes": [],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isPrimary": true,
        "nationalities": "<unknown>",
        "externalId": "<string>",
        "metadata": {},
        "birthDate": "2023-12-25",
        "middleName": "<string>",
        "lastName": "<unknown>",
        "employment": {
          "isEmployee": true,
          "employeeId": "<string>",
          "position": "<string>",
          "department": "<string>",
          "startDate": "2023-12-25"
        },
        "scopeData": {
          "MX": {
            "rfc": "<string>",
            "curp": "<string>",
            "actividadVulnerable": {
              "ARI": {},
              "AVI": {
                "username": "<unknown>"
              },
              "INM": {},
              "JYS": {},
              "MJR": {},
              "MPC": {},
              "TSC": {},
              "VEH": {}
            },
            "cnbv": {
              "TRANSMISOR": {
                "numeroCuenta": "<unknown>",
                "claveSujetoObligado": "<unknown>"
              }
            }
          },
          "US": "<unknown>"
        },
        "email": "<string>",
        "phone": "<string>",
        "age": 0,
        "addresses": [
          {
            "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "isPrimary": true,
            "street": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "type": "home",
            "country": "<unknown>",
            "externalId": "<string>",
            "metadata": {},
            "scopeData": {
              "MX": {
                "exteriorNumber": "<string>",
                "interiorNumber": "<string>",
                "neighborhood": "<string>",
                "municipality": "<string>",
                "betweenStreets": "<string>",
                "reference": "<string>",
                "cnbv": {
                  "TRANSMISOR": "<unknown>"
                }
              },
              "US": "<unknown>"
            }
          }
        ],
        "contactMethods": [
          {
            "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "value": "<string>",
            "isVerified": true,
            "verifiedAt": "2023-11-07T05:31:56Z",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "isPrimary": false,
            "label": "<string>",
            "externalId": "<string>",
            "metadata": {}
          }
        ],
        "bankAccounts": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "accountNumber": "<string>",
            "bankName": "<string>",
            "country": "<unknown>",
            "currency": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "bankCode": "<string>",
            "type": "checking",
            "isPrimary": true,
            "isActive": true,
            "label": "<string>",
            "externalId": "<string>",
            "metadata": {},
            "clabe": "<unknown>",
            "codigoBanco": "<string>",
            "codigoPlaza": "<string>"
          }
        ],
        "documents": [
          {
            "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "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": {}
          }
        ],
        "linkedClients": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "client": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "type": "<unknown>",
              "name": "<unknown>",
              "nationalities": "<unknown>",
              "externalId": "<unknown>",
              "metadata": "<unknown>",
              "birthDate": "<unknown>",
              "middleName": "<unknown>",
              "lastName": "<unknown>",
              "employment": "<unknown>",
              "scopes": "<unknown>",
              "scopeData": "<unknown>"
            },
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "metadata": {}
          }
        ],
        "riskAssessments": {},
        "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".

Body

application/json
items
object[]
required
Required array length: 1 - 250 elements
atomic
boolean
default:true

Response

200 - application/json

OK

atomic
any
required
data
object[]
required