POST /identities/{id}/children

Add children to an identity. The _id as path param is the identityId.

POST/identities/{id}/children

Add Child to Identity Children

Headers

Bearer access token returned by the authentication endpoint.

The API key used for authentication when making requests to the API Gateway.

API version selector for Conomy endpoints. Use 24-04-2025 for the current version.

Identifies the application making the request.

Path parameters

Unique identifier for the identity.

Request body

Array of identity ids (strings) that are going to be linked as child to the identityId father

Responses

idstring

Unique identifier for the internal service.

typestring

USERRepresents an individual with personal identifying information.

ORGANIZATIONA legal entity such as a company, institution, or other juridical person

namestring

The name of the entity (for users) or the official name (for organizations).

nicknamestring

An alternative or preferred name for the entity.

emailstringemail

The email address associated with the entity.

phonestring

the phone number linked to the entity. Include +(phone country code)

documentNumberstring

The document number associated with the entity for identification purposes.

documentTypestring

Documeny type of the entity (e.g., RUT, CURP, CURL). Go to the Supported Identity document types page for the complete list of supported values.

idvstring

Identity verification reference

securityOptionsobject

countrystring

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

childrenobject[]

A list of related entities (e.g., subsidiaries for organizations or dependent users

statusstring

The current status of the entity. PENDING, PENDING_EMAIL_VALIDATION, PENDING_PHONE_VALIDATION, SCREENING, ACTIVE

externalIdstring

External reference ID (client purpose).

lastnamestring

The last name of the user (if applicable).

bankAccountobject

Schema representing a bank account, including essential details about the account holder and financial institution.

rulesobject

Custom rules or policies applicable to the entity.

genderstring

Gender information (if applicable

kycobject

Information related to Know Your Customer (KYC) compliance

watchListobject

Watchlist information for compliance or fraud detection.

extendedDatastring[]

Additional data.

createdAtstringdate-time

Creation date UTC format.

updatedAtstringdate-time

Time of last update made to the entity, UTC format.

addressobject

The entity’s address information.

Request

POST /sandbox/identities/{id}/children HTTP/1.1
Host: api.conomyhq.com
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {YOUR_API_KEY}
conomyhq-api-version: 24-04-2025
User-Agent: MyApp/1.0
Content-Type: application/json

{
  "children": [
    "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
    "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
  ]
}

curl -X POST \
  'https://api.conomyhq.com/sandbox/identities/{id}/children' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {YOUR_API_KEY}' \
  -H 'conomyhq-api-version: 24-04-2025' \
  -H 'User-Agent: MyApp/1.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "children": [
      "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
      "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
    ]
  }'

const response = await fetch('https://api.conomyhq.com/sandbox/identities/{id}/children', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "children": [
      "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
      "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
    ]
  }),
});

const data = await response.json();

import requests

payload = {
    "children": [
        "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
        "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
    ]
}

response = requests.post(
    'https://api.conomyhq.com/sandbox/identities/{id}/children',
    headers={
    'Authorization': 'Bearer {ACCESS_TOKEN}',
    'x-api-key': '{YOUR_API_KEY}',
    'conomyhq-api-version': '24-04-2025',
    'User-Agent': 'MyApp/1.0',
    'Content-Type': 'application/json',
    },
    json=payload
)

data = response.json()

package main

import (
	"encoding/json"
	"net/http"
	"bytes"
)

func main() {
	payload, _ := json.Marshal(	{
	  "children": [
	    "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
	    "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
	  ]
	})
	body := bytes.NewBuffer(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/identities/{id}/children", body)
	req.Header.Set("Authorization", "Bearer {ACCESS_TOKEN}")
	req.Header.Set("x-api-key", "{YOUR_API_KEY}")
	req.Header.Set("conomyhq-api-version", "24-04-2025")
	req.Header.Set("User-Agent", "MyApp/1.0")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()

	var data map[string]any
	json.NewDecoder(resp.Body).Decode(&data)
}

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let resp = client
        .post("https://api.conomyhq.com/sandbox/identities/{id}/children")
        .header("Authorization", "Bearer {ACCESS_TOKEN}")
        .header("x-api-key", "{YOUR_API_KEY}")
        .header("conomyhq-api-version", "24-04-2025")
        .header("User-Agent", "MyApp/1.0")
        .header("Content-Type", "application/json")
        .json(&json!({
        "children": [
                "1a5925ac-4629-f7bf-db28-ac0f655e3eef",
                "3cbf2e28-ff31-804c-829e-bf97ed3d44a2"
        ]
}))
        .send()
        .await?;

    let data: serde_json::Value = resp.json().await?;
    Ok(())
}

Response

{
  "id": "string",
  "type": "USER",
  "name": "string",
  "nickname": "string",
  "email": "user@example.com",
  "phone": "string",
  "documentNumber": "string",
  "documentType": "string",
  "idv": "string",
  "securityOptions": {}
}