POST api/Auth/1/1/UserRegister

Registrar nuevo usuario


Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

Objeto que contiene los parámetros de la petición

SFE.Auth.Core.Requests.UserRegisterRequest
NombreDescripciónTipoInformación Adicional
userTypeAltId

Identificador del tipo de usuario

string

Matching regular expression pattern: [0-9a-fA-F\-]{32,36}

Max length: 128

userRegistrationId

Id de la plantilla de registro

integer

N/A

username

Nombre de usuario

string

Matching regular expression pattern: ^[0-9a-zA-Z.]+$

Max length: 100

phoneNumber

Número de teléfono móvil

string

Matching regular expression pattern: ^[0-9]+$

Max length: 256

emailAddress

Dirección de correo electrónico

string

Matching regular expression pattern: [\w._%+-]+@[\w.-]+\.[a-zA-Z]{2,4}

Max length: 100

firstName

Nombres Se puede omitir si hay un item de userRegisterData mapeado hacia este campo

string

Max length: 150

lastName

Apellidos Se puede omitir si hay un item de userRegisterData mapeado hacia este campo

string

Max length: 150

documentType

Tipo de documento de identidad Este id se define en la tabla Profile_DocumentType Se puede omitir si hay un item de userRegisterData mapeado hacia este campo

integer

N/A

documentNumber

Número de documento de identidad Se puede omitir si hay un item de userRegisterData mapeado hacia este campo

string

Max length: 32

userRegisterData

Lista de datos de registro

Collection of SFE.Core.Models.AUTH.UserRegisterData

N/A

initialPassword

Contraseña inicial encriptada en formato JWT [campo opcional] En la definición de tipo de usuario se especifica si se permite fijar una contraseña inicial, sino es ignorada. Si es nula, también será ignorada.

string

Max length: 1000

preconfirmationId

Id de la confirmación previa en caso de que se halla realizado una (opcional)

string

N/A

clientDevicePublicKey

Llave pública del dispositivo cliente

string

Max length: 1000

isPreOnboarding

Indica si es una preafiliación que debe confirmarse o completarse posteriormente

boolean

N/A

AffilationChannel

Canal de afiliación

SFE.Auth.Plugin.Shared.Models.AUTH.EnumAffiliationChannel

N/A

applicationId

Identificador de la aplicación que consume el API. Valor constante acordado con el cliente

string

N/A

applicationVersion

Identificador de la versión de la aplicación

string

Max length: 100

applicationOS

Identificador del sistema operativo de la aplicación (en mayúsculas) Ejemplo: ANDROID, IOS

string

Max length: 100

language

Código ISO 639-1 de dos letras del idioma usado para los mensajes

string

Max length: 5

deviceId

Identificador del dispositivo registrado

integer

N/A

deviceAltId

Identificador alternativo del dispositivo registrado

string

Max length: 128

ipAddress

Dirección IP pública del dispositivo

string

Matching regular expression pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

latitude

Latitud dela ubicación enviada por dispositivo

string

Max length: 50

longitude

Longitud dela ubicación enviada por dispositivo

string

Max length: 50

additionalParameters

Datos adicionales

Dictionary of string [key] and string [value]

N/A

Ejemplos de request:

application/json, text/json

Ejemplo:
{
  "userTypeAltId": "sample string 1",
  "userRegistrationId": 2,
  "username": "sample string 3",
  "phoneNumber": "sample string 4",
  "emailAddress": "sample string 5",
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "documentType": 8,
  "documentNumber": "sample string 9",
  "userRegisterData": [
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "isValidated": true,
      "signature": "sample string 4",
      "vDate": "2026-04-05T07:50:25.7754237-05:00",
      "mimeType": "sample string 5"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2",
      "isValidated": true,
      "signature": "sample string 4",
      "vDate": "2026-04-05T07:50:25.7754237-05:00",
      "mimeType": "sample string 5"
    }
  ],
  "initialPassword": "sample string 10",
  "preconfirmationId": "sample string 11",
  "clientDevicePublicKey": "sample string 12",
  "isPreOnboarding": true,
  "AffilationChannel": 0,
  "applicationId": "sample string 14",
  "applicationVersion": "sample string 15",
  "applicationOS": "sample string 16",
  "language": "sample string 17",
  "deviceId": 18,
  "deviceAltId": "sample string 19",
  "ipAddress": "sample string 20",
  "latitude": "sample string 21",
  "longitude": "sample string 22",
  "additionalParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Ejemplo:
<UserRegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
  <additionalParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </additionalParameters>
  <applicationId>sample string 14</applicationId>
  <applicationOS>sample string 16</applicationOS>
  <applicationVersion>sample string 15</applicationVersion>
  <deviceAltId>sample string 19</deviceAltId>
  <deviceId>18</deviceId>
  <ipAddress>sample string 20</ipAddress>
  <language>sample string 17</language>
  <latitude>sample string 21</latitude>
  <longitude>sample string 22</longitude>
  <AffilationChannel>Undefined</AffilationChannel>
  <clientDevicePublicKey>sample string 12</clientDevicePublicKey>
  <documentNumber>sample string 9</documentNumber>
  <documentType>8</documentType>
  <emailAddress>sample string 5</emailAddress>
  <firstName>sample string 6</firstName>
  <initialPassword>sample string 10</initialPassword>
  <isPreOnboarding>true</isPreOnboarding>
  <lastName>sample string 7</lastName>
  <phoneNumber>sample string 4</phoneNumber>
  <preconfirmationId>sample string 11</preconfirmationId>
  <userRegisterData xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Core.Models.AUTH">
    <d2p1:UserRegisterData>
      <d2p1:isValidated>true</d2p1:isValidated>
      <d2p1:mimeType>sample string 5</d2p1:mimeType>
      <d2p1:name>sample string 1</d2p1:name>
      <d2p1:signature>sample string 4</d2p1:signature>
      <d2p1:vDate>2026-04-05T07:50:25.7754237-05:00</d2p1:vDate>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:UserRegisterData>
    <d2p1:UserRegisterData>
      <d2p1:isValidated>true</d2p1:isValidated>
      <d2p1:mimeType>sample string 5</d2p1:mimeType>
      <d2p1:name>sample string 1</d2p1:name>
      <d2p1:signature>sample string 4</d2p1:signature>
      <d2p1:vDate>2026-04-05T07:50:25.7754237-05:00</d2p1:vDate>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:UserRegisterData>
  </userRegisterData>
  <userRegistrationId>2</userRegistrationId>
  <userTypeAltId>sample string 1</userTypeAltId>
  <username>sample string 3</username>
</UserRegisterRequest>

Información del Response

Descripción de los parametros

KinPOS.API.GenericResultOfSFE.Auth.Core.Requests.UserRegisterResponse
NombreDescripciónTipoInformación Adicional
encryptedData

string

N/A

response

SFE.Auth.Core.Requests.UserRegisterResponse

N/A

Ejemplos de response:

application/json, text/json

Ejemplo:
{
  "encryptedData": "sample string 1"
}

application/xml

Ejemplo:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SFE.Auth.Core.Requests.UserRegisterResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Ejemplo:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SFE.Auth.Core.Requests.UserRegisterResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.