VeriFlow.me Service API
  1. Session Request
VeriFlow.me Service API
  • Introduction
  • API Authentication
  • Webhook
  • Prices
  • Dashboard
    • 0. Secure Login & OTP
    • 1. Main Dashboard
    • 2. Verifications
    • 3. New Verification
    • 4. Verification Detail
    • 5. Manual Review
  • Services
    • Session Request
      • Create a new Session Request
        POST
      • Update a Request
        PUT
      • Fetch a single request by its ID
        GET
      • Fetch all requests for the authenticated organization
        GET
    • Standalone
      • Create a new ID Verification Request
      • Create a new Face Match Request
      • Create a new Age Estimation Request
      • Create a new Proof of Address Request
      • Create a new AML Screening Request
      • Create a new Face Search Request
      • Create a new Passive Liveness Request
      • Create a new Database Validation Request
    • Phone Verification
      • Create a new Phone Verification Request
      • Check a Phone Verification Code
    • Email Verification
      • Create a new Email Verification Request
      • Check an Email Verification Code
  1. Session Request

Fetch a single request by its ID

GET
/v2/requests/{id}

Solicitud

Autorización
Proporciona tu token bearer en el encabezado
Authorization
al realizar solicitudes a recursos protegidos.
Ejemplo:
Authorization: Bearer ********************
Parámetros de ruta

Respuestas

🟢200Correcto
application/json
Request details
Body

🟠404No encontrado
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.veriflow.me/v2/requests/' \
--header 'Authorization: Bearer <token>'
Respuesta Ejemplo de Respuesta
{
    "success": true,
    "payload": {
        "request": {
            "id": "string",
            "organizationId": "string",
            "type": "string",
            "session": "http://example.com",
            "workflow": "string",
            "status": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "cost": 0,
            "info": {
                "metadata": null,
                "init": {
                    "url": "http://example.com",
                    "status": "string",
                    "workflowId": "string"
                },
                "response": {
                    "sessionUrl": "http://example.com",
                    "status": "string",
                    "workflowId": "string",
                    "createdAt": "string",
                    "features": [
                        "string"
                    ],
                    "expectedDetails": {
                        "firstName": "string",
                        "lastName": "string"
                    },
                    "contactDetails": {
                        "email": "user@example.com",
                        "emailLang": "string",
                        "sendNotificationEmails": true
                    },
                    "reviews": [
                        {
                            "user": "string",
                            "newStatus": "string",
                            "createdAt": "string",
                            "comment": "string"
                        }
                    ],
                    "nfc": {
                        "status": "string",
                        "portraitImage": "http://example.com",
                        "signatureImage": "http://example.com",
                        "chipData": {
                            "property1": null,
                            "property2": null
                        },
                        "certificateSummary": {
                            "property1": null,
                            "property2": null
                        },
                        "authenticity": {
                            "sodIntegrity": true,
                            "dgIntegrity": true
                        },
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ]
                    },
                    "phone": {
                        "status": "string",
                        "phoneNumberPrefix": "string",
                        "phoneNumber": "string",
                        "fullNumber": "string",
                        "countryCode": "string",
                        "countryName": "string",
                        "isDisposable": true,
                        "isVirtual": true,
                        "verificationMethod": "string",
                        "verificationAttempts": 0,
                        "verifiedAt": "2019-08-24T14:15:22Z",
                        "carrier": {
                            "name": "string",
                            "type": "string"
                        },
                        "lifecycle": [
                            {
                                "type": "string",
                                "timestamp": "string",
                                "details": null,
                                "fee": 0
                            }
                        ],
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ]
                    },
                    "databaseValidation": {
                        "issuingState": "string",
                        "validationType": "string",
                        "matchType": "string",
                        "status": "string",
                        "validations": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "screenedData": {
                            "lastName": "string",
                            "firstName": "string",
                            "taxNumber": "string",
                            "dateOfBirth": "string",
                            "documentType": "string",
                            "expirationDate": "string"
                        },
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ]
                    },
                    "email": {
                        "status": "string",
                        "email": "user@example.com",
                        "isBreached": true,
                        "isDisposable": true,
                        "isUndeliverable": true,
                        "verificationAttempts": 0,
                        "verifiedAt": "2019-08-24T14:15:22Z",
                        "lifecycle": [
                            {
                                "type": "string",
                                "timestamp": "string",
                                "details": null,
                                "fee": 0
                            }
                        ],
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "breaches": [
                            {
                                "name": "string",
                                "domain": "string",
                                "logoPath": "http://example.com",
                                "breachDate": "string",
                                "description": "string",
                                "isVerified": true,
                                "breachEmailsCount": 0,
                                "dataClasses": [
                                    "string"
                                ]
                            }
                        ]
                    },
                    "ipAnalysis": {
                        "status": "string",
                        "organization": null,
                        "locationsInfo": null,
                        "deviceBrand": "string",
                        "deviceModel": "string",
                        "browserFamily": "string",
                        "osFamily": "string",
                        "platform": "string",
                        "ipCountry": "string",
                        "ipCountryCode": "string",
                        "ipState": "string",
                        "ipCity": "string",
                        "latitude": 0,
                        "longitude": 0,
                        "ipAddress": "string",
                        "isp": "string",
                        "isVpnOrTor": true,
                        "isDataCenter": true,
                        "timeZone": "string",
                        "timeZoneOffset": "string",
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ]
                    },
                    "liveness": {
                        "status": "string",
                        "method": "string",
                        "score": 0,
                        "referenceImage": "http://example.com",
                        "videoUrl": "http://example.com",
                        "ageEstimation": 0,
                        "matches": [
                            null
                        ],
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "userImage": {
                            "bestAngle": 0,
                            "entities": [
                                {
                                    "age": 0,
                                    "confidence": 0,
                                    "gender": "string",
                                    "bbox": [
                                        0
                                    ]
                                }
                            ]
                        }
                    },
                    "faceMatch": {
                        "status": "string",
                        "score": 0,
                        "sourceImage": "http://example.com",
                        "targetImage": "http://example.com",
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "userImage": {
                            "bestAngle": 0,
                            "entities": [
                                {
                                    "age": 0,
                                    "confidence": 0,
                                    "gender": "string",
                                    "bbox": [
                                        0
                                    ]
                                }
                            ]
                        },
                        "refImage": {
                            "bestAngle": 0,
                            "entities": [
                                {
                                    "age": 0,
                                    "confidence": 0,
                                    "gender": "string",
                                    "bbox": [
                                        0
                                    ]
                                }
                            ]
                        }
                    },
                    "poa": {
                        "status": "string",
                        "documentFile": "http://example.com",
                        "issuingState": "string",
                        "documentType": "string",
                        "documentLanguage": "string",
                        "documentMetadata": null,
                        "issuer": "string",
                        "issueDate": "string",
                        "poaAddress": "string",
                        "poaFormattedAddress": "string",
                        "expectedDetailsAddress": null,
                        "expectedDetailsFormattedAddress": null,
                        "expectedDetailsParsedAddress": {},
                        "extraFields": {
                            "property1": null,
                            "property2": null
                        },
                        "extraFiles": [
                            "http://example.com"
                        ],
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "poaParsedAddress": {
                            "id": "string",
                            "rawResults": null,
                            "addressType": "string",
                            "city": "string",
                            "label": "string",
                            "region": "string",
                            "street1": "string",
                            "street2": "string",
                            "postalCode": "string",
                            "country": "string",
                            "documentLocation": {
                                "latitude": 0,
                                "longitude": 0
                            }
                        }
                    },
                    "idVerification": {
                        "status": "string",
                        "documentType": "string",
                        "documentNumber": "string",
                        "personalNumber": "string",
                        "portraitImage": "http://example.com",
                        "frontImage": "http://example.com",
                        "frontVideo": "http://example.com",
                        "backImage": "http://example.com",
                        "backVideo": "http://example.com",
                        "fullFrontImage": "http://example.com",
                        "fullBackImage": "http://example.com",
                        "dateOfBirth": "string",
                        "age": 0,
                        "expirationDate": "string",
                        "dateOfIssue": "string",
                        "issuingState": "string",
                        "issuingStateName": "string",
                        "firstName": "string",
                        "lastName": "string",
                        "fullName": "string",
                        "gender": "string",
                        "address": "string",
                        "formattedAddress": "string",
                        "placeOfBirth": "string",
                        "maritalStatus": "string",
                        "nationality": "string",
                        "extraFields": {
                            "property1": null,
                            "property2": null
                        },
                        "extraFiles": [
                            "http://example.com"
                        ],
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "parsedAddress": {
                            "id": "string",
                            "rawResults": null,
                            "addressType": "string",
                            "city": "string",
                            "label": "string",
                            "region": "string",
                            "street1": "string",
                            "street2": "string",
                            "postalCode": "string",
                            "country": "string",
                            "documentLocation": {
                                "latitude": 0,
                                "longitude": 0
                            }
                        }
                    },
                    "ageEstimation": {
                        "status": "string",
                        "method": "string",
                        "score": 0,
                        "ageEstimation": 0,
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "userImage": {
                            "bestAngle": 0,
                            "entities": [
                                {
                                    "age": 0,
                                    "confidence": 0,
                                    "gender": "string",
                                    "bbox": [
                                        0
                                    ]
                                }
                            ]
                        }
                    },
                    "questionnaire": {
                        "questionnaireId": "string",
                        "title": "string",
                        "description": "string",
                        "defaultLanguage": "string",
                        "isActive": true,
                        "status": "string",
                        "languages": [
                            "string"
                        ],
                        "sections": [
                            {
                                "title": "string",
                                "description": "string",
                                "items": [
                                    {
                                        "uuid": "string",
                                        "order": 0,
                                        "elementType": "string",
                                        "isRequired": true,
                                        "title": "string",
                                        "maxFiles": 0,
                                        "answer": null,
                                        "description": "string",
                                        "placeholder": "string",
                                        "choices": [
                                            null
                                        ]
                                    }
                                ]
                            }
                        ]
                    },
                    "aml": {
                        "status": "string",
                        "totalHits": 0,
                        "score": 0,
                        "isOngoingMonitoringEnabled": true,
                        "nextOngoingMonitoringBillDate": null,
                        "screenedData": {
                            "fullName": "string",
                            "nationality": "string",
                            "dateOfBirth": "string",
                            "documentNumber": "string"
                        },
                        "warnings": [
                            {
                                "feature": "string",
                                "risk": "string",
                                "additionalData": null,
                                "logType": "string",
                                "shortDescription": "string",
                                "longDescription": "string"
                            }
                        ],
                        "hits": [
                            {
                                "id": "string",
                                "url": "http://example.com",
                                "match": true,
                                "score": 0,
                                "target": null,
                                "caption": "string",
                                "features": null,
                                "rcaName": "string",
                                "lastSeen": "string",
                                "riskView": null,
                                "firstSeen": "string",
                                "matchScore": 0,
                                "adverseMediaDetails": null,
                                "datasets": [
                                    "string"
                                ],
                                "properties": {
                                    "property1": null,
                                    "property2": null
                                },
                                "pepMatches": [
                                    null
                                ],
                                "linkedEntities": [
                                    null
                                ],
                                "warningMatches": [
                                    null
                                ],
                                "sanctionMatches": [
                                    null
                                ],
                                "adverseMediaMatches": [
                                    null
                                ],
                                "additionalInformation": {
                                    "property1": null,
                                    "property2": null
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}
Modificado en 2025-12-06 17:47:50
Anterior
Update a Request
Siguiente
Fetch all requests for the authenticated organization
Built with