POST api/Auth/1/1/GenerateCnfCodeNotUser

Solicitar generación de código de confirmación previa al registro


Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

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

Identificador del tipo de usuario

string

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

Max length: 128

mobileNumber

Número de teléfono celular a confirmar

string

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

Max length: 50

Min length: 5

internationalPrefix

Prefijo internacional del número de teléfono

string

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

Max length: 50

Min length: 5

emailAddress

Dirección de corre electrónico a confirmar

string

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

Max length: 100

auditInfo

Información de auditoria sobre la petición

SFE.Auth.Core.Model.RequestAuditInfo

N/A

recoveryId

Identificador de Recuperacion de Cuenta . Solo en caso de que la petición sea exitosa.

integer

N/A

userRegistrationId

Id de la plantilla de registro

integer

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",
  "mobileNumber": "sample string 2",
  "internationalPrefix": "sample string 3",
  "emailAddress": "sample string 4",
  "auditInfo": {
    "ipAddress": "sample string 1",
    "latitude": "sample string 2",
    "longitude": "sample string 3",
    "countryCode": "sample string 4"
  },
  "recoveryId": 5,
  "userRegistrationId": 6,
  "applicationId": "sample string 7",
  "applicationVersion": "sample string 8",
  "applicationOS": "sample string 9",
  "language": "sample string 10",
  "deviceId": 11,
  "deviceAltId": "sample string 12",
  "ipAddress": "sample string 13",
  "latitude": "sample string 14",
  "longitude": "sample string 15",
  "additionalParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Ejemplo:
<GenerateCnfCodeNotUserRequest 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 7</applicationId>
  <applicationOS>sample string 9</applicationOS>
  <applicationVersion>sample string 8</applicationVersion>
  <deviceAltId>sample string 12</deviceAltId>
  <deviceId>11</deviceId>
  <ipAddress>sample string 13</ipAddress>
  <language>sample string 10</language>
  <latitude>sample string 14</latitude>
  <longitude>sample string 15</longitude>
  <auditInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Model">
    <d2p1:countryCode>sample string 4</d2p1:countryCode>
    <d2p1:ipAddress>sample string 1</d2p1:ipAddress>
    <d2p1:latitude>sample string 2</d2p1:latitude>
    <d2p1:longitude>sample string 3</d2p1:longitude>
  </auditInfo>
  <emailAddress>sample string 4</emailAddress>
  <internationalPrefix>sample string 3</internationalPrefix>
  <mobileNumber>sample string 2</mobileNumber>
  <recoveryId>5</recoveryId>
  <userRegistrationId>6</userRegistrationId>
  <userTypeAltId>sample string 1</userTypeAltId>
</GenerateCnfCodeNotUserRequest>

Información del Response

Descripción de los parametros

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

string

N/A

response

SFE.Auth.Core.Requests.GenerateCnfCodeNotUserResponse

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.GenerateCnfCodeNotUserResponse' 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.GenerateCnfCodeNotUserResponse' 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.