Unlink a child client from a parent client

curl --request DELETE \
  --url https://api.artu.ai/clients/{parentClientId}/links/{childClientId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '{}'

import requests

url = "https://api.artu.ai/clients/{parentClientId}/links/{childClientId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "X-Environment": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Environment': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.artu.ai/clients/{parentClientId}/links/{childClientId}', 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/clients/{parentClientId}/links/{childClientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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/clients/{parentClientId}/links/{childClientId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.artu.ai/clients/{parentClientId}/links/{childClientId}")
  .header("Authorization", "Bearer <token>")
  .header("X-Environment", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artu.ai/clients/{parentClientId}/links/{childClientId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "type": "individual",
  "name": "<string>",
  "scopes": [
    "base"
  ],
  "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>",
      "actividadEconomica": "1000000",
      "giroMercantil": "1000000",
      "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>",
      "scope": "base",
      "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": {
              "localidad": "10100005"
            }
          }
        },
        "US": "<unknown>"
      }
    }
  ],
  "contactMethods": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "email",
      "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": "MX",
      "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",
      "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": {}
    }
  ],
  "linkedClients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "relationshipType": "legal_representative",
      "client": {
        "type": "individual",
        "name": "<string>",
        "scopes": [
          "base"
        ],
        "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>",
            "actividadEconomica": "1000000",
            "giroMercantil": "1000000",
            "actividadVulnerable": {
              "ARI": {},
              "AVI": {
                "username": "<unknown>"
              },
              "INM": {},
              "JYS": {},
              "MJR": {},
              "MPC": {},
              "TSC": {},
              "VEH": {}
            },
            "cnbv": {
              "TRANSMISOR": {
                "numeroCuenta": "<unknown>",
                "claveSujetoObligado": "<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>"
    }
  ]
}

DELETE

clients

{parentClientId}

links

{childClientId}

Unlink a child client from a parent client

curl --request DELETE \
  --url https://api.artu.ai/clients/{parentClientId}/links/{childClientId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '{}'

import requests

url = "https://api.artu.ai/clients/{parentClientId}/links/{childClientId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "X-Environment": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Environment': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://api.artu.ai/clients/{parentClientId}/links/{childClientId}', 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/clients/{parentClientId}/links/{childClientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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/clients/{parentClientId}/links/{childClientId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.artu.ai/clients/{parentClientId}/links/{childClientId}")
  .header("Authorization", "Bearer <token>")
  .header("X-Environment", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artu.ai/clients/{parentClientId}/links/{childClientId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "type": "individual",
  "name": "<string>",
  "scopes": [
    "base"
  ],
  "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>",
      "actividadEconomica": "1000000",
      "giroMercantil": "1000000",
      "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>",
      "scope": "base",
      "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": {
              "localidad": "10100005"
            }
          }
        },
        "US": "<unknown>"
      }
    }
  ],
  "contactMethods": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "email",
      "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": "MX",
      "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",
      "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": {}
    }
  ],
  "linkedClients": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "relationshipType": "legal_representative",
      "client": {
        "type": "individual",
        "name": "<string>",
        "scopes": [
          "base"
        ],
        "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>",
            "actividadEconomica": "1000000",
            "giroMercantil": "1000000",
            "actividadVulnerable": {
              "ARI": {},
              "AVI": {
                "username": "<unknown>"
              },
              "INM": {},
              "JYS": {},
              "MJR": {},
              "MPC": {},
              "TSC": {},
              "VEH": {}
            },
            "cnbv": {
              "TRANSMISOR": {
                "numeroCuenta": "<unknown>",
                "claveSujetoObligado": "<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>"
    }
  ]
}

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

parentClientId

string<uuid>

required

childClientId

string<uuid>

required

Body

application/json

relationshipType

enum<string>

required

Available options:

legal_representative,

controlling_beneficiary

Response

200 - application/json

Option 1
Option 2
Option 3

type

any

required

Type

name

string

required

Name

Minimum string length: 1

scopes

enum<string>[]

required

Minimum array length: 1

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

string<uuid>

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

isPrimary

boolean

required

nationalities

any

Nationalities

externalId

string

External ID

metadata

object

Metadata

Show child attributes

birthDate

string<date>

Birth Date

middleName

string

Middle Name

lastName

any

Last Name

employment

object

Employment

Show child attributes

scopeData

object

Show child attributes

string | null

phone

string | null

age

integer | null

Required range: -9007199254740991 <= x <= 9007199254740991

addresses

object[]

Show child attributes

contactMethods

object[]

Show child attributes

bankAccounts

object[]

Option 1
Option 2

Show child attributes

documents

object[]

Show child attributes

linkedClients

object[]

Show child attributes

riskAssessments

object

Show child attributes

Overview

Audit Logs

Audits

Health

Addresses

Bank Accounts

Clients

Contact Methods

Custom Reference Data

Documents

Evidence

Transactions

Alerts

Alert Items

Exchange Rates

Reference Data

Products

Provider Credentials

Reports

Signable Templates

Workflow Templates

Workflows

Tags

Tenant Details

Screening

Identity

Unlink a child client from a parent client

Authorizations

Path Parameters

Body

Response