POST /customers

Create customer

POST/customers

Create customer

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.

Request body

Unique identifier for the internal service.

Payer's name

Payer's email

Payer's last name

Payer's phone number without prefix

Phone number prefix (e.g., +57)

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.

The document number associated with the documentType

The entity’s address information.

administrativeAreaLevel1string

The first-level administrative division.

administrativeAreaLevel2string

The second-level administrative division.

administrativeAreaLevel3string

The third-level administrative division.

streetstring

The name of the street.

streetNumberstring

The street number.

optionalAddressstring

Additional address details.

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.

zipcodestring

Zipcode f the address

Responses

idstring

Unique identifier for the internal service.

firstNamestringrequired

Payer's name

emailstring

Payer's email

lastNamestring

Payer's last name

phoneNumberstring

Payer's phone number without prefix

phoneNumberPrefixstring

Phone number prefix (e.g., +57)

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.

documentNumberstring

The document number associated with the documentType

addressobject

The entity’s address information.

Request

POST /sandbox/customers 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

{
  "id": "string",
  "firstName": "string",
  "email": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "phoneNumberPrefix": "string",
  "documentType": "string",
  "documentNumber": "string",
  "address": {}
}

curl -X POST \
  'https://api.conomyhq.com/sandbox/customers' \
  -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 '{
    "id": "string",
    "firstName": "string",
    "email": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "phoneNumberPrefix": "string",
    "documentType": "string",
    "documentNumber": "string",
    "address": {}
  }'

const response = await fetch('https://api.conomyhq.com/sandbox/customers', {
  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({
    "id": "string",
    "firstName": "string",
    "email": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "phoneNumberPrefix": "string",
    "documentType": "string",
    "documentNumber": "string",
    "address": {}
  }),
});

const data = await response.json();

import requests

payload = {
    "id": "string",
    "firstName": "string",
    "email": "string",
    "lastName": "string",
    "phoneNumber": "string",
    "phoneNumberPrefix": "string",
    "documentType": "string",
    "documentNumber": "string",
    "address": {}
}

response = requests.post(
    'https://api.conomyhq.com/sandbox/customers',
    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(	{
	  "id": "string",
	  "firstName": "string",
	  "email": "string",
	  "lastName": "string",
	  "phoneNumber": "string",
	  "phoneNumberPrefix": "string",
	  "documentType": "string",
	  "documentNumber": "string",
	  "address": {}
	})
	body := bytes.NewBuffer(payload)
	req, _ := http.NewRequest("POST", "https://api.conomyhq.com/sandbox/customers", 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/customers")
        .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!({
        "id": "string",
        "firstName": "string",
        "email": "string",
        "lastName": "string",
        "phoneNumber": "string",
        "phoneNumberPrefix": "string",
        "documentType": "string",
        "documentNumber": "string",
        "address": {}
}))
        .send()
        .await?;

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

Response

{
  "id": "string",
  "firstName": "string",
  "email": "string",
  "lastName": "string",
  "phoneNumber": "string",
  "phoneNumberPrefix": "string",
  "documentType": "string",
  "documentNumber": "string",
  "address": {}
}