POST api/Auth/1/1/CheckDocumentPreonboarding

Realiza la comprobación del documento en el flujo de preafiliación

Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

SFE.Auth.Core.Requests.CheckDocumentPreonboardingRequest

Nombre	Descripción	Tipo	Información Adicional
userRegistrationId	Id de la plantilla de registro	integer	N/A
userAltId	Identificador de usuario	string	Matching regular expression pattern: [0-9a-fA-F\-]{32,36} Max length: 128
mobileNumber	Número de teléfono móvil del usuario a validar	string	Matching regular expression pattern: ^[0-9]+$ Max length: 50 Min length: 5
email	Dirección de correo electrónico del usuario a validar	string	Matching regular expression pattern: [\w._%+-]+@[\w.-]+\.[a-zA-Z]{2,4} Max length: 100
docType	Tipo de documento de identidad	integer	N/A
docNumber	Número de documento de identidad	string	Max length: 150
password	Nueva contraseña en caso de validación exitosa. Encriptada en formato JWT.	string	Max length: 1000
clientDevicePublicKey	Llave pública RSA del dispositivo coddificada en formato Base64Url	string	Max length: 4096
additional	Datos adicionales de imagen codificados en Base64	Dictionary of string [key] and string [value]	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:

{
  "userRegistrationId": 1,
  "userAltId": "sample string 2",
  "mobileNumber": "sample string 3",
  "email": "sample string 4",
  "docType": 5,
  "docNumber": "sample string 6",
  "password": "sample string 7",
  "clientDevicePublicKey": "sample string 8",
  "additional": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "applicationId": "sample string 9",
  "applicationVersion": "sample string 10",
  "applicationOS": "sample string 11",
  "language": "sample string 12",
  "deviceId": 13,
  "deviceAltId": "sample string 14",
  "ipAddress": "sample string 15",
  "latitude": "sample string 16",
  "longitude": "sample string 17",
  "additionalParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Ejemplo:

<CheckDocumentPreonboardingRequest 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 9</applicationId>
  <applicationOS>sample string 11</applicationOS>
  <applicationVersion>sample string 10</applicationVersion>
  <deviceAltId>sample string 14</deviceAltId>
  <deviceId>13</deviceId>
  <ipAddress>sample string 15</ipAddress>
  <language>sample string 12</language>
  <latitude>sample string 16</latitude>
  <longitude>sample string 17</longitude>
  <additional 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>
  </additional>
  <clientDevicePublicKey>sample string 8</clientDevicePublicKey>
  <docNumber>sample string 6</docNumber>
  <docType>5</docType>
  <email>sample string 4</email>
  <mobileNumber>sample string 3</mobileNumber>
  <password>sample string 7</password>
  <userAltId>sample string 2</userAltId>
  <userRegistrationId>1</userRegistrationId>
</CheckDocumentPreonboardingRequest>

Información del Response

Descripción de los parametros

KinPOS.API.GenericResultOfSFE.Auth.Core.Requests.CheckDocumentPreonboardingResponse

Nombre	Descripción	Tipo	Información Adicional
encryptedData		string	N/A
response		SFE.Auth.Core.Requests.CheckDocumentPreonboardingResponse	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.CheckDocumentPreonboardingResponse' 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.CheckDocumentPreonboardingResponse' 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.