POST api/Auth/1/1/GenerateCnfCodeEx

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.GenerateCnfCodeExRequest
NombreDescripciónTipoInformación Adicional
userTypeAltId

Identificador del tipo de usuario

string

N/A

mobileNumber

Número de teléfono celular a confirmar

string

N/A

emailAddress

Dirección de corre electrónico a confirmar

string

N/A

auditInfo

Información de auditoria sobre la petición

SFE.Auth.Core.Model.RequestAuditInfo

N/A

targetOperation

Tipo de operación asociada a la solicitud de OTP

SFE.Auth.Core.Model.EnumGenerateCnfCodeOperation

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

application/xml, text/xml

Ejemplo:
<GenerateCnfCodeExRequest 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 5</applicationId>
  <applicationOS>sample string 7</applicationOS>
  <applicationVersion>sample string 6</applicationVersion>
  <deviceAltId>sample string 10</deviceAltId>
  <deviceId>9</deviceId>
  <ipAddress>sample string 11</ipAddress>
  <language>sample string 8</language>
  <latitude>sample string 12</latitude>
  <longitude>sample string 13</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 3</emailAddress>
  <mobileNumber>sample string 2</mobileNumber>
  <targetOperation>Undefined</targetOperation>
  <userRegistrationId>4</userRegistrationId>
  <userTypeAltId>sample string 1</userTypeAltId>
</GenerateCnfCodeExRequest>

Información del Response

Descripción de los parametros

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

string

N/A

response

SFE.Auth.Core.Requests.GenerateCnfCodeExResponse

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