- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- ProofingEvidence
- Evidencia
- ReverificationContext
Es un extremo para probar a un usuario para una credencial digital, con una lista de evidencias especificada por el emisor y para un dispositivo específico.
Solicitud HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
| Representación JSON |
|---|
{ "requestMetadata": { object ( |
| Campos | |
|---|---|
requestMetadata |
Obligatorio. Son los metadatos sobre la solicitud, que son obligatorios en todas las solicitudes. |
deviceReferenceId |
Obligatorio. Es el ID que corresponde al dispositivo y la clave de identidad asociada con el dispositivo. NO es un ID de dispositivo, lo que significa que, si el usuario tuviera dos credenciales separadas en el mismo dispositivo, este ID sería diferente entre ellas. Este ID se proporciona en todas las solicitudes y se puede usar para correlacionarlas. |
proofingId |
Obligatorio. Es un identificador opaco que representa una prueba con un paquete específico de evidencia para un dispositivo específico. Ej.: UUID |
evidence[] |
Obligatorio. Es la lista de evidencias necesarias para probar a un usuario para una credencial digital. |
Campo de unión proofing_context. Es el contexto de la prueba. Está vacío para la prueba inicial. proofing_context puede ser solo uno de los parámetros siguientes: |
|
reverificationContext |
Es el contexto de la prueba de reverificación. |
Cuerpo de la respuesta
Es un reconocimiento de una solicitud para probar a un usuario para una credencial digital, que indica que la prueba ahora se está procesando.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
|---|
{
"responseMetadata": {
object ( |
| Campos | |
|---|---|
responseMetadata |
Obligatorio. Son los metadatos sobre la respuesta, que son obligatorios en todas las respuestas. |
proofingId |
Obligatorio. Es el identificador opaco que representa una prueba con un paquete específico de evidencia para un dispositivo específico. Es el mismo ID de prueba que se envió en la solicitud. |
ProofingEvidence
Es un objeto que representa una sola evidencia.
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión evidence_type. Obligatorio. Es un oneof que indica cómo se presenta la evidencia. evidence_type puede ser solo uno de los parámetros siguientes: |
|
preAuthorizationCode |
Es el código de autorización previa enviado por el emisor. |
Evidencia
Es un objeto que representa una sola evidencia.
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión presencetype. Obligatorio. Es un oneof que indica cómo se presenta la evidencia. presencetype puede ser solo uno de los parámetros siguientes: |
|
encryptedData |
Es el valor encriptado y los metadatos de encriptación necesarios para desencriptar el valor. |
unencryptedValue |
Es el valor codificado en base64 de la evidencia. |
unencryptedInteger |
Es el valor entero de la evidencia. |
ReverificationContext
Es el contexto necesario para activar la reverificación de la credencial.
| Representación JSON |
|---|
{ "credentialId": string } |
| Campos | |
|---|---|
credentialId |
Obligatorio. Es el ID de credencial en el que se realiza la reverificación. |