Create an identity

This endpoint allows you to create a new identity.

This endpoint is used to create a new identity within the system. The identity can represent either a USER or a COMPANY and must include relevant information like an external identifier, type, or status.

post

Authorizations

x-api-keyBearer

Body

idstringoptional

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

identityExternalIdstringoptional

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

typestring · enumoptional

Specifies whether the identity represents a USER or a COMPANY.

Available options:

statusstring · enumoptional

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

Available options:

contractstringoptional

The contract identifier associated with the identity, if applicable.

imagestringoptional

A URL to the image or avatar representing the identity.

sessionobjectoptional

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

bankAccountsall of[]optional

A list of bank accounts associated with the identity.

userobjectoptional

Details of the user associated with this identity. This field is required when the 'type' is USER.

companyobjectoptional

Details of the company associated with this identity. This field is required when the 'type' is COMPANY.

extendedDataobject[]optional

Additional data related to the identity, which can vary depending on use cases.

createdAtstringoptional

The timestamp of when the identity was created, in ISO 8601 format.

updatedAtstringoptional

The timestamp of the last update to the identity, in ISO 8601 format.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/identities' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

400

500

201

{
  "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