Endpoints para consulta de personas, cuentas bancarias y validacion de titularidad.
Los endpoints de esta seccion comparten la misma raiz de servicio y utilizan una API Key en el header Ocp-Apim-Subscription-Key.
Endpoints documentados
Header comun
| Header | Valor esperado | Descripcion |
|---|---|---|
Ocp-Apim-Subscription-Key | <API_KEY> | API Key asociada a la suscripcion con permisos sobre Primary Identity. |
Content-Type | application/json | Header recomendado para las requests de ejemplo. |
EntityDataFull
EntityDataFull devuelve informacion identificatoria, fiscal, de contacto y padrones asociados a una persona o entidad consultada por CUIT.
URL
Consolida la informacion principal de identificacion, actividad, impuestos, domicilios, medios de contacto y registros especiales asociados al CUIT consultado.
GET https://apids.primary.com.ar/pid-ro/v2/api/EntityDataFull?key={CUIT}Headers
Headers necesarios para invocar el servicio.
| Header | Valor | Estado | Descripción |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | <API_KEY> | Requerido | API Key habilitada para consumir Primary Identity. |
| Content-Type | application/json | Requerido | Header recomendado para las requests de ejemplo. |
Parámetros
Parámetros esperados por la URL para ejecutar la consulta.
| Nombre | Ubicación | Tipo | Estado | Descripción |
|---|---|---|---|---|
| key | query | string | Requerido | CUIT de la persona o entidad a consultar. |
Probar endpoint
La API Key se usa sólo para esta prueba y no se persiste en cookies.
CUIT de la persona o entidad que desea consultar. Requerido.
Request preview
GET https://apids.primary.com.ar/pid-ro/v2/api/EntityDataFull?key={cuit}Ocp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripcion |
|---|---|---|
naturalKey | number | null | Identificador numerico interno asociado a la entidad. |
keyType | string | null | Tipo de clave consultada. |
documentType | string | null | Tipo de documento principal. |
personType | string | null | Tipo de persona, por ejemplo humana o juridica. |
name | string | null | Nombre de la persona humana. |
lastName | string | null | Apellido de la persona humana. |
documentNumber | string | null | Numero de documento o CUIT consultado. |
birthdate | string | null | Fecha de nacimiento, cuando aplica. |
deathdate | string | null | Fecha de fallecimiento, cuando aplica. |
keyStatus | string | null | Estado de vigencia de la clave. |
legalType | string | null | Tipo societario o legal. |
inscriptionDate | string | null | Fecha de inscripcion de la entidad. |
associatedInactiveKey | string | null | Clave inactiva asociada, si existe. |
mainActivityId | number | null | Identificador de actividad principal. |
mainActivityPeriod | number | null | Periodo asociado a la actividad principal. |
mainActivityDescription | string | null | Descripcion de la actividad principal. |
closeMonth | number | null | Mes de cierre de ejercicio. |
socialContractDate | string | null | Fecha de contrato social o constitucion. |
businessName | string | null | Razon social o nombre comercial. |
gender | string | null | Genero, cuando aplica. |
residenceType | string | null | Tipo de residencia fiscal o registral. |
inscriptionAuthority | string | null | Organismo de inscripcion. |
inscriptionNumber | string | null | Numero de inscripcion. |
nationalEquityPercentage | string | null | Porcentaje de capital nacional informado. |
displayName | string | null | Nombre formateado para mostrar en interfaz. |
taxes | array<object> | Padrones y estados impositivos asociados al CUIT. |
taxesConditions | array<object> | Condiciones tributarias por impuesto. |
emails | array<object> | Direcciones de correo registradas. |
activities | array<object> | Actividades economicas asociadas. |
telephones | array<object> | Telefonos registrados. |
addresses | array<object> | Domicilios asociados a la entidad. |
exclusions | array<object> | Registros de exclusion o certificados vigentes/historicos. |
specialRecordEntries | array<object> | Entradas de registros especiales o padrones particulares. |
Estructura de taxes[]
| Campo | Tipo |
|---|---|
description | string | null |
daysInPeriod | string | null |
taxId | number | null |
period | number | null |
status | string | null |
inscriptionDate | string | null |
estadoImpuesto | string | undefined |
motivo | string | undefined |
Estructura de taxesConditions[]
| Campo | Tipo |
|---|---|
taxName | string | null |
taxCondition | string | null |
Estructura de emails[]
| Campo | Tipo |
|---|---|
address | string | null |
status | string | null |
addressType | string | null |
Estructura de activities[]
| Campo | Tipo |
|---|---|
description | string | null |
periodStart | number | null |
order | number | null |
activityId | number | null |
nomenclator | number | null |
Estructura de telephones[]
| Campo | Tipo |
|---|---|
number | string | null |
lineType | string | null |
numberType | string | null |
Estructura de addresses[]
| Campo | Tipo |
|---|---|
description | string | null |
zipCode | string | null |
state | string | null |
stateId | number | null |
street | string | null |
number | number | null |
floor | string | null |
block | string | null |
sector | string | null |
tower | string | null |
line1 | string | null |
city | string | null |
aditionalDataType | string | null |
localDepartmentOffice | string | null |
addressStatus | string | null |
addressTypeAux | string | null |
Estructura de exclusions[]
| Campo | Tipo |
|---|---|
issuer | string | null |
rule | string | null |
ruleName | string | null |
issueDate | string | null |
endDate | string | null |
percentage | number | null |
certificationNumber | string | null |
createdAt | string | null |
fiscalPeriod | string | null |
Estructura de specialRecordEntries[]
| Campo | Tipo |
|---|---|
issuer | string | null |
rule | string | null |
ruleName | string | null |
category | string | null |
inclusionPublicationDate | string | null |
recordUpdateTime | string | null |
suspensionPublicationDate | string | null |
suspensionRemovalDate | string | null |
status | string | null |
entityData | record<string, string | number | null> | null |
createdAt | string | null |
BankAccounts
BankAccounts permite consultar informacion de una cuenta bancaria a partir de un identificador CBU o CVU.
URL
Devuelve la informacion asociada a la cuenta consultada, incluyendo datos de identificacion bancaria y titularidad cuando el servicio los informa.
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}Headers
Headers necesarios para invocar el servicio.
| Header | Valor | Estado | Descripción |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | <API_KEY> | Requerido | API Key habilitada para consumir Primary Identity. |
| Content-Type | application/json | Requerido | Header recomendado para las requests de ejemplo. |
Parámetros
Parámetros esperados por la URL para ejecutar la consulta.
| Nombre | Ubicación | Tipo | Estado | Descripción |
|---|---|---|---|---|
| CBU | path | string | Requerido | CBU o CVU de la cuenta bancaria a consultar. |
Probar endpoint
La API Key se usa sólo para esta prueba y no se persiste en cookies.
Identificador bancario de la cuenta a consultar. Requerido.
Request preview
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{cbu}Ocp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripcion |
|---|---|---|
owners | array<object> | Titulares informados para la cuenta bancaria consultada. |
type | string | Tipo de cuenta informado por el servicio, por ejemplo CA. |
isActive | boolean | Indica si la cuenta se encuentra activa. |
currency | string | Moneda de la cuenta bancaria. |
label | string | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
accountRouting | object | Datos de identificacion de la cuenta bancaria consultada. |
bankRouting | object | Datos de identificacion de la entidad bancaria asociada. |
Estructura de owners[]
| Campo | Tipo | Descripcion |
|---|---|---|
id | string | Identificador del titular informado, por ejemplo un CUIT. |
displayName | string | Nombre o razon social del titular. |
idType | string | Tipo de identificador del titular, por ejemplo CUIT. |
isPhysicalPerson | boolean | Indica si el titular informado corresponde a una persona humana. |
Estructura de accountRouting
| Campo | Tipo | Descripcion |
|---|---|---|
scheme | string | Tipo de identificador bancario utilizado para la cuenta, por ejemplo CBU. |
address | string | Valor del identificador bancario de la cuenta consultada. |
Estructura de bankRouting
| Campo | Tipo | Descripcion |
|---|---|---|
scheme | string | Tipo de identificador usado para describir la entidad bancaria. |
address | string | Nombre o descripcion de la entidad bancaria. |
code | string | Codigo de la entidad bancaria informado por el servicio. |
BankAccounts Ownership
Este endpoint valida si un CUIT corresponde a la titularidad informada para una cuenta bancaria identificada por CBU.
URL
Permite verificar si el CUIT consultado coincide con la titularidad informada para la cuenta bancaria indicada.
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}/ownership/{CUIT}Headers
Headers necesarios para invocar el servicio.
| Header | Valor | Estado | Descripción |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | <API_KEY> | Requerido | API Key habilitada para consumir Primary Identity. |
| Content-Type | application/json | Requerido | Header recomendado para las requests de ejemplo. |
Parámetros
Parámetros esperados por la URL para ejecutar la consulta.
| Nombre | Ubicación | Tipo | Estado | Descripción |
|---|---|---|---|---|
| CBU | path | string | Requerido | CBU o CVU de la cuenta bancaria a validar. |
| CUIT | path | string | Requerido | CUIT que se desea contrastar contra la titularidad de la cuenta. |
Probar endpoint
La API Key se usa sólo para esta prueba y no se persiste en cookies.
Cuenta bancaria a validar. Requerido.
CUIT a contrastar con la titularidad de la cuenta. Requerido.
Request preview
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{cbu}/ownership/{cuit}Ocp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripcion |
|---|---|---|
valid | boolean | Indica si existe correspondencia entre el titular informado y la cuenta bancaria consultada. |
account | object | Datos resumidos de la cuenta y del titular evaluado en la validacion. |
Estructura de account
| Campo | Tipo | Descripcion |
|---|---|---|
type | string | Tipo de cuenta informado por el servicio, por ejemplo CA. |
currency | string | Moneda asociada a la cuenta bancaria. |
bank | string | Nombre de la entidad bancaria asociada a la cuenta. |
alias | string | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
active | boolean | Indica si la cuenta se encuentra activa. |
ownerName | string | Nombre o razon social del titular evaluado. |
ownerKeyType | string | Tipo de identificador del titular, por ejemplo CUIT. |
ownerIsHuman | boolean | Indica si el titular evaluado corresponde a una persona humana. |
