Retrieve an identity

This endpoint allows you to get identity.

This endpoint retrieves details of a specific identity using its unique identifier. The identity can represent either a USER or a COMPANY, and its details can include status, type, or external references.

get

Authorizations

x-api-keyBearer

Path parameters

identityIdstringrequired

A unique identifier of the identity, represented as a UUID (Universally Unique Identifier).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/identities/{identityId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

500

200

{
  "id": "text",
  "identityExternalId": "text",
  "type": "USER",
  "status": "BLOCKED",
  "contract": "text",
  "image": "text",
  "session": {
    "deviceToken": "text",
    "IP": "text",
    "logginAttempts": 1
  },
  "bankAccounts": [
    {
      "default": true,
      "id": "text",
      "identity": "text",
      "externalId": "text",
      "accountNumber": "text",
      "nickName": "text",
      "country": "ARG",
      "currency": "ARS",
      "financialInstitution": "text",
      "type": "CASH_ACCOUNT",
      "accountHolder": "text",
      "accountHolderDni": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "iban": "text",
      "sortCode": "text"
    }
  ],
  "user": {
    "name": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "documentType": "text",
    "documentNumber": "text",
    "career": "text",
    "birthDate": "text",
    "country": "ARG",
    "gender": "text",
    "kyc": "text",
    "aml": "text"
  },
  "company": {
    "name": "text",
    "nickname": "text",
    "taxCondition": "text",
    "registrationNumber": "text",
    "companyLegalStructure": "text",
    "email": "text",
    "country": "ARG",
    "activity": "text",
    "legalRepresentative": {
      "name": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "powerOfAttorneyDocument": "text",
      "pep": true
    },
    "address": {
      "country": "ARG",
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "zipcode": "text",
      "optionalAddress": "text"
    },
    "beneficialOwners": [
      {
        "name": "text",
        "identificationNumber": "text",
        "ownership": "text",
        "legalEntity": true
      }
    ],
    "individualShareholders": [
      {
        "name": "text",
        "identificationNumber": "text",
        "ownership": "text"
      }
    ],
    "AML": {
      "registrationRequired": true,
      "reportingCountries": [
        "ARG"
      ],
      "registrationDocument": "text",
      "officer": {
        "name": "text",
        "email": "text",
        "phoneNumber": "text"
      }
    },
    "documents": {
      "companyLegalStatus": "text",
      "taxIdentification": "text",
      "proofOfAddress": "text",
      "privacyPolicy": "text"
    }
  },
  "extendedData": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Example response