Skip to main content
POST
/
clients
/
sync
Sync a client and all related resources
curl --request POST \
  --url https://api.artu.ai/clients/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client": {
    "type": "<unknown>",
    "name": "<string>",
    "scopes": [],
    "nationalities": "<string>",
    "externalId": "<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>"
    }
  },
  "addresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "home",
      "isPrimary": true,
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "externalId": "<string>",
      "metadata": {},
      "scopeData": {
        "MX": {
          "exteriorNumber": "<string>",
          "interiorNumber": "<string>",
          "neighborhood": "<string>",
          "municipality": "<string>",
          "betweenStreets": "<string>",
          "reference": "<string>",
          "cnbv": {}
        },
        "US": "<unknown>"
      },
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_delete": true
    }
  ],
  "contactMethods": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "isPrimary": true,
      "value": "<string>",
      "label": "<string>",
      "externalId": "<string>",
      "metadata": {},
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_delete": true
    }
  ],
  "bankAccounts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountNumber": "<string>",
      "bankName": "<string>",
      "bankCode": "<string>",
      "country": "<unknown>",
      "currency": "<string>",
      "isPrimary": true,
      "isActive": true,
      "label": "<string>",
      "externalId": "<string>",
      "metadata": {},
      "clabe": "<string>",
      "codigoBanco": "<string>",
      "codigoPlaza": "<string>",
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_delete": true
    }
  ],
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiresAt": "2023-12-25",
      "externalId": "<string>",
      "metadata": {},
      "fields": {},
      "_delete": true
    }
  ],
  "linkedClients": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "child": {
        "type": "<unknown>",
        "name": "<string>",
        "scopes": [],
        "nationalities": "<string>",
        "externalId": "<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>"
        }
      },
      "metadata": {}
    }
  ],
  "replaceMode": true
}
'
{
  "client": {
    "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": "<string>",
            "claveSujetoObligado": "<string>"
          }
        }
      },
      "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": {}
            }
          },
          "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": {
          "type": "<unknown>",
          "name": "<string>",
          "scopes": [],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "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": "<unknown>",
                "AVI": "<unknown>",
                "INM": "<unknown>",
                "JYS": "<unknown>",
                "MJR": "<unknown>",
                "MPC": "<unknown>",
                "TSC": "<unknown>",
                "VEH": "<unknown>"
              },
              "cnbv": {
                "TRANSMISOR": "<unknown>"
              }
            },
            "US": "<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>"
      }
    ]
  },
  "addresses": {
    "created": [
      {
        "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": {}
            }
          },
          "US": "<unknown>"
        }
      }
    ],
    "updated": [
      {
        "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": {}
            }
          },
          "US": "<unknown>"
        }
      }
    ],
    "deleted": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "contactMethods": {
    "created": [
      {
        "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": {}
      }
    ],
    "updated": [
      {
        "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": {}
      }
    ],
    "deleted": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "bankAccounts": {
    "created": [
      {
        "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>"
      }
    ],
    "updated": [
      {
        "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>"
      }
    ],
    "deleted": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "documents": {
    "created": [
      {
        "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": {}
      }
    ],
    "updated": [
      {
        "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": {}
      }
    ],
    "deleted": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

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
​
clientId
string<uuid>
​
client
object
​
addresses
object[]
Maximum array length: 250
​
contactMethods
object[]
Maximum array length: 250
​
bankAccounts
object[]
Maximum array length: 250
​
documents
object[]
Maximum array length: 250
​
linkedClients
object[]
Maximum array length: 250
​
replaceMode
boolean

Response

200 - application/json

OK

​
client
object
required
​
addresses
object
required
​
contactMethods
object
required
​
bankAccounts
object
required
​
documents
object
required