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/identities/{identityId}

Authorization

x-api-keyBearer

Path parameters

identityId*string

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

Response

200400500

Example response

Body

application/json

idid

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

identityExternalIdstring

An external identifier used to represent the identity in external systems.

typeenum

Specifies whether the identity represents a USER or a COMPANY.

USERCOMPANY

statusenum

The current status of the identity, covering various stages like ACTIVE, PENDING, or BLOCKED.

BLOCKEDINACTIVEACTIVEPENDINGPENDING_PHONE_VALIDATIONPENDING_EMAIL_VALIDATIONPENDING_2FAPENDING_ACCOUNTSPENDING_VERIFICATIONPROCCESING_VERIFICATIONFAILED_VERIFICATION

contractstring

The contract identifier associated with the identity, if applicable.

imagestring

A URL to the image or avatar representing the identity.

sessionobject

Information about the current session for the identity, including device and login details.

bankAccountsarray of object

A list of bank accounts associated with the identity.

useruser

companycompany

extendedDataextendedData

The extendedData model allows for additional key-value pairs to be added to entities, providing extensibility and flexibility for custom or extra information not covered by default fields.

createdAtcreatedAt

Creation date, in ISO 8601 date format

updatedAtupdatedAt

Date of last update, in ISO 8601 date format

Request

JavaScriptCurlPython

const response = await fetch('/identities/{identityId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "identityExternalId": "text",
  "type": "USER",
  "status": "BLOCKED",
  "contract": "text",
  "image": "text",
  "session": {
    "deviceToken": "text",
    "IP": "text",
    "logginAttempts": 0
  },
  "bankAccounts": [
    {
      "default": false,
      "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": false
    },
    "address": {
      "country": "ARG",
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "zipcode": "text",
      "optionalAddress": "text"
    },
    "beneficialOwners": [
      {
        "name": "text",
        "identificationNumber": "text",
        "ownership": "text",
        "legalEntity": false
      }
    ],
    "individualShareholders": [
      {
        "name": "text",
        "identificationNumber": "text",
        "ownership": "text"
      }
    ],
    "AML": {
      "registrationRequired": false,
      "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"
}