Create a new signer

POST

signer

{
  "signer_id": "0195b009-a139-7ff2-adac-15e3c3ecfc88",
  "id": "0195b009-a139-7ff2-adac-15e3c3ecfc88",
  "handle": "wYe6h63CNqoLxJet5jP1WWLhGi8D11ZGij",
  "keeper": [
    {
      "public": "7ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef4",
      "scheme": "ecdsa-ed25519",
      "secret": "046d541aec939b4748943e49cc1117a70966a6fc87345e6052a54f1e69ea48d5"
    }
  ],
  "labels": {
    "type": "PERSON",
    "status": "ACTIVE",
    "created": "2025-03-19T15:12:55.993-05:00",
    "updated": "2025-03-19T15:12:55.993-05:00",
    "createdBy": "mSJkneiASd",
    "aliasType": "ALPHANUM",
    "aliasValue": "@jorge",
    "proprietary": "CC",
    "identification": "1010101010",
    "firstName": "Jorge",
    "lastName": "Diaz",
    "bankId": "900123456",
    "bankAccountType": "SVGS",
    "bankAccountNumber": "4123456789",
    "routerReference": "$bancorojo",
    "targetSpbviCode": "TFY",
    "consented": "2025-03-13T20:38:07-05:00",
    "received": "2025-03-13T20:38:07.123-05:00",
    "dispatched": "2025-03-13T20:38:10.123-05:00"
  },
  "error": {
    "code": 0,
    "message": "Success"
  }
}

Body

application/json

handle

string | null

Required string length: 28 - 35

Example:

"wfQeFLxQCFF5zrAjHnVX7tJnigmN98mDLM"

keeper

object[]

labels

object

labels.type

enum<string>

Type of a signer

Available options:

PERSON,

BUSINESS

labels.aliasType

enum<string>

Alias type of the signer

Available options:

ALPHANUM,

EMAIL,

MERCHANT,

PHONE,

NRIC

labels.aliasValue

string

Value of the alias. The format of the alias depends on the aliasType:

"ALPHANUM": Starts with @. Max 20 and min 5 alphanumeric characters after the @.
"EMAIL": Max 92 characters, must contain only one @. Max 30 characters before the @ and 61 after.
"MERCHANT": Starts with 00 and contains 10 characrters in total.
"PHONE": Starts with 3 and contains 9 numbers after.
"NRIC": Max 18 and min 3 alphanumeric characters.

Required string length: 3 - 92

Example:

"@jorge"

labels.proprietary

enum<string>

'Proprietary label of the signer'

"CC": Cédula de Ciudadanía
"CE": Cédula de Extranjería
"PA": Pasaporte
"TI": Tarjeta de Identidad
"NUIP": Número Único de Identificación Personal
"NIT": Número de Identificación Tributaria

Available options:

CC,

CE,

PA,

TI,

NUIP,

NIT

labels.description

string | null

Description of the signer

Maximum length: 255

Example:

"signer for spi"

labels.identification

string

Identification of the signer. Alphanumeric characters.

Maximum length: 18

Example:

"1010101010"

labels.name

string | null

Legal entity name. Only for BUSINESS type.

Maximum length: 140

Example:

"Cognito inc"

labels.firstName

string | null

First name of the signer. Only for PERSON type.

Maximum length: 140

Example:

"Jorge"

labels.secondName

string | null

Optional second name of the signer. Only for PERSON type.

Maximum length: 140

Example:

"Ivan"

labels.lastName

string | null

Last name of the signer. Only for PERSON type.

Maximum length: 140

Example:

"Diaz"

labels.secondLastName

string | null

Optional second last name of the signer. Only for PERSON type.

Maximum length: 140

Example:

"Gomez"

labels.countryOfResidence

string | null

ISO code of the country of residence of the signer.

Maximum length: 2

Example:

"CO"

labels.bankAccountType

enum<string>

Type of bank account.

"SVGS": Savings
"CACC": Checking
"DBMO": Low-amount deposits
"DORD": Ordinary deposits
"DBMI": Inclusive low-amount deposits

Available options:

SVGS,

CACC,

DBMO,

DORD,

DBMI

labels.bankAccountNumber

string

Bank account number of the signer. Only digits

Maximum length: 34

Example:

"4123456789"

labels.bankBicfi

string | null

Bank BICFI code of the bank. Only digits

Maximum length: 4

Example:

"1234"

labels.bankName

string | null

Name of the bank

Maximum length: 64

Example:

"Banco Rojo"

labels.bankId

string | null

Bank NIT

Maximum length: 9

Example:

"900123456"

labels.routerReference

string

Bank wallet identifier.

Maximum length: 34

Example:

"$bancorojo"

labels.targetSpbviCode

enum<string>

Type of SPBVI code

'TFY': TransfiYa
'ENT': Entre cuentas
'CRB': Credibanco
'VIS': Visionamos
'SRV': Servibanca

Available options:

TFY,

ENT,

CRB,

VIS,

SRV

labels.consented

string

Date of consent in ISO 8601

Example:

"2025-03-13T20:38:07-05:00"

labels.received

string

Date of reception in ISO 8601 with milliseconds precision

Example:

"2025-03-13T20:38:07.123-05:00"

labels.dispatched

string

Date of dispatch in ISO 8601 with milliseconds precision

Example:

"2025-03-13T20:38:10.123-05:00"

Response

200

application/json

Signer created successfully

string

signer_id

string

handle

string

keeper

object[]

labels

object

error

object

Retrieve signers Get a signer with signer handle.

{
  "signer_id": "0195b009-a139-7ff2-adac-15e3c3ecfc88",
  "id": "0195b009-a139-7ff2-adac-15e3c3ecfc88",
  "handle": "wYe6h63CNqoLxJet5jP1WWLhGi8D11ZGij",
  "keeper": [
    {
      "public": "7ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef44ee7ff1f4527ef4",
      "scheme": "ecdsa-ed25519",
      "secret": "046d541aec939b4748943e49cc1117a70966a6fc87345e6052a54f1e69ea48d5"
    }
  ],
  "labels": {
    "type": "PERSON",
    "status": "ACTIVE",
    "created": "2025-03-19T15:12:55.993-05:00",
    "updated": "2025-03-19T15:12:55.993-05:00",
    "createdBy": "mSJkneiASd",
    "aliasType": "ALPHANUM",
    "aliasValue": "@jorge",
    "proprietary": "CC",
    "identification": "1010101010",
    "firstName": "Jorge",
    "lastName": "Diaz",
    "bankId": "900123456",
    "bankAccountType": "SVGS",
    "bankAccountNumber": "4123456789",
    "routerReference": "$bancorojo",
    "targetSpbviCode": "TFY",
    "consented": "2025-03-13T20:38:07-05:00",
    "received": "2025-03-13T20:38:07.123-05:00",
    "dispatched": "2025-03-13T20:38:10.123-05:00"
  },
  "error": {
    "code": 0,
    "message": "Success"
  }
}

Como empezar

Guias de uso

Acerca de

APIs

Archivos de Soporte

Body

Response