Clientes

La API de Clientes gestiona el padrón de clientes del socio — las entidades en cuyo nombre el socio ejecuta operaciones de FX, transferencias y trading. Los registros de cliente llevan estado de KYC, enlaces a documentos, y el mapeo de nivel de stream que determina la cotización FX para búsquedas por customer_external_user_id (vea Órdenes FX).

La superficie se divide en dos patrones de acceso:

• /me/* — operaciones sobre los registros del cliente actualmente autenticado. Se usa cuando el socio actúa en nombre del cliente que tiene sesión activa.
• /{customerId}/* — operaciones sobre un cliente específico que el socio gestiona. Se usa cuando el socio necesita leer o actualizar un registro de cliente por ID sin que ese cliente tenga sesión activa.

Inicio rápido

# Leer el perfil del cliente autenticado
curl -fsS "https://sandbox-api.ariari.xyz/api/v1/customers/me/profile" \
  -H "Ocp-Apim-Subscription-Key: $SU_CLAVE"

# Buscar en el padrón de clientes del socio
curl -fsS -X POST "https://sandbox-api.ariari.xyz/api/v1/customers/search" \
  -H "Ocp-Apim-Subscription-Key: $SU_CLAVE" \
  -H "Content-Type: application/json" \
  -d '{ "query": "Mario", "page": 1, "pageSize": 25 }'

# Leer el perfil de un cliente gestionado específico por ID
curl -fsS "https://sandbox-api.ariari.xyz/api/v1/customers/550e8400-e29b-41d4-a716-446655440000/profile" \
  -H "Ocp-Apim-Subscription-Key: $SU_CLAVE"

Ejemplo multi-lenguaje — `getMyProfile`

Generado desde el spec OpenAPI vivo. Elija su lenguaje; su elección persiste a través de otras páginas.

curl -fsS -X GET "https://sandbox-api.ariari.xyz/api/v1/customers/me/profile" \
  -H "Ocp-Apim-Subscription-Key: $YOUR_KEY"

const response = await fetch('https://sandbox-api.ariari.xyz/api/v1/customers/me/profile', {
  method: 'GET',
  headers: {
    'Ocp-Apim-Subscription-Key': process.env.ARI_SANDBOX_KEY!,
  },
});

if (!response.ok) {
  const problem = await response.json();
  throw new Error(`${problem.error_code}: ${problem.detail}`);
}

const result = await response.json();

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key",
    Environment.GetEnvironmentVariable("ARI_SANDBOX_KEY"));

var response = await client.GetAsync("https://sandbox-api.ariari.xyz/api/v1/customers/me/profile");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();

val client = HttpClient(CIO) {
    install(ContentNegotiation) { json() }
}

val response: HttpResponse = client.get("https://sandbox-api.ariari.xyz/api/v1/customers/me/profile") {
    header("Ocp-Apim-Subscription-Key", System.getenv("ARI_SANDBOX_KEY"))
}

val result: String = response.bodyAsText()

Vea también

• Autenticación — modelo de clave de suscripción APIM, scopes customers.manage / customers.read
• Cuentas Externas — el registro de IBAN vive bajo /customers/me/external-accounts/*
• Paginación — forma de consulta de search
• Errores — códigos DB-CUS-* y DB-AML-*
• Verificaciones — flujo de estado de verificación KYC
• Padrón — búsqueda en padrón electoral de Costa Rica durante onboarding
• Sandbox — clientes de prueba precargados (test_customer_a, test_customer_b, test_customer_c)