Obtener una sesión
Returns a session, with what was read from the ID once it's decided.
Returns a session, with what was read from the ID once it's decided.
apiKeyAutorizaciónBearer <token>Tu clave de API, que empieza con upsky_test_ o upsky_live_.
id*stringuuidLa sesión.
application/json- response
id*stringuuidobject*"verify.session""verify.session"livemode*booleantier*string"age""identity""identity_plus"status*stringpending until the person opens the link, in_progress while they take photos, processing once submitted, then approved, rejected or needs_review. A link that's never finished ends expired or canceled, and isn't charged.
"pending""in_progress""processing""approved""rejected""needs_review""expired""canceled"url*|The link to send the person to. Null once it can't be used anymore.
reference*string|nullmetadata*project_id*|uuidreturn_url*string|nullminimum_age*integerallow_selfie_upload*booleanWhether the person may send a selfie from their photos. When false, it has to be taken with the camera on the page.
show_result*booleanSi el enlace muestra a la persona el resultado una vez decidido.
thresholds*Qué tan segura debía estar cada revisión, copiado al crear la sesión de la configuración de Verify de su proyecto, o de la de tu equipo si el proyecto no tiene. Una puntuación igual o mayor que la marca de aprobación pasa; desde la marca de revisión hasta la de aprobación va a revisión; por debajo de la marca de revisión se rechaza.
options*Con qué opciones corre la sesión, copiadas al crearla de la configuración de Verify de su proyecto, o de tu equipo, más lo que hayas indicado en la solicitud.
reasons*array<>Why the session ended as it did.
checks*What each check found. Empty until the session is decided.
document_type*|"mx_ine""passport""us_drivers_license""id_card"nullverified_outputs*|What was read from the ID. Identity tier and above, once decided. Only returned when you read one session, never in lists or webhooks.
expires_at*stringcreated_at*stringstarted_at*string|nullsubmitted_at*string|nulldecided_at*string|nullreviewed_at*string|nullredacted_at*|Cuándo se borraron los datos de la persona de la sesión con el endpoint de redacción.
curl -X GET 'https://api.upsky.dev/v1/verify/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "verify.session", "livemode": true, "tier": "age", "status": "pending", "url": "string", "reference": "string", "metadata": { "property1": "string", "property2": "string" }, "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "return_url": "string", "minimum_age": 0, "allow_selfie_upload": true, "show_result": true, "thresholds": { "preset": "relaxed", "liveness_pass": 0, "liveness_review": 0, "face_match_pass": 0, "face_match_review": 0, "age_buffer_years": 0 }, "options": { "documents": { "allowed_types": [ "mx_ine" ], "allowed_countries": [ "string" ], "max_attempts": 0 }, "rules": { "liveness_inconclusive": "reject", "age_inconclusive": "reject", "document_unreadable": "reject", "document_expired": "reject", "document_checksum_failed": "reject", "document_type_mismatch": "reject", "document_country_not_accepted": "reject", "date_of_birth_missing": "reject", "face_match_inconclusive": "reject", "age_estimate_mismatch": "reject", "name_mismatch": "reject", "date_of_birth_mismatch": "reject" }, "retention_days": 0 }, "reasons": [ "liveness_failed" ], "checks": { "liveness": { "status": "passed", "confidence": 0, "feedback": [ "face_not_visible" ] }, "age": { "status": "passed", "minimum_age": 0, "estimated_low": 0, "estimated_high": 0, "estimated_age": 0, "age_from_document": 0 }, "document": { "status": "passed", "document_type": "mx_ine", "expired": true, "checksums_valid": true, "type_matches": true, "country_accepted": true }, "face_match": { "status": "passed", "similarity": 0 }, "data_match": { "status": "passed", "first_name": "match", "last_name": "match", "date_of_birth": "match" } }, "document_type": "mx_ine", "verified_outputs": { "first_name": "string", "last_name": "string", "date_of_birth": "string", "document_type": "mx_ine", "document_number": "string", "issuing_country": "string", "expires_on": "string" }, "expires_at": "string", "created_at": "string", "started_at": "string", "submitted_at": "string", "decided_at": "string", "reviewed_at": "string", "redacted_at": "string"}Crear una sesión POST
Starts a verification and returns the `url` to send the person to. A live key sets the tier's price aside, which is kept only if the session reaches a decision.
List sessions GET
Your team's sessions in the key's mode, newest first. Pass the last `id` as `starting_after` for the next page.