GET

Verify a Factor Protect & Voice

Use this API to verify completion of OneLogin Push or OneLogin Voice factors, or in cases where email is used as an authentication factor via Magic Link rather than OTP. This API endpoint must be used to confirm if a user has completed their Push or Voice verification or has clicked the emailed Magic Link.

Resource URL

https://<subdomain>.onelogin.com/api/2/mfa/users/<user_id>/verifications/<verification_id>

Header Parameter

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using the Manage All scope.

Resource Parameters

user_id

required

integer

Set to the id of the user.

If you don't know the user's id, use the Get Users API call to return all users and their id values.

verification_id

required

integer

The verification_id is returned on activation of the factor or you can get the device_id using the Activate Factor API call.

Pending user action to confirm push notification or OneLogin Voice call

200 OK
401 Unauthorized
404 Not Found

[
  {
      "id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
      "status": "pending",
      "device_id": "3919988"
  }
]

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Authentication Failure"
    }
}

{
    "statusCode": 404,
    "name": "NotFound",
    "message": "The resource can't be found or the server has not found anything matching the Request-URI"
}
```json

</div>
</div>


### User has accepted push notification or OneLogin Voice call

<div class="code-tabs">
<ul class="tab-links" role="tablist">
<li class="t-link active" data-tab="1" role="tab" aria-selected="true" tabindex="0">200 OK</li>
<li class="t-link" data-tab="2" role="tab" aria-selected="false" tabindex="0">401 Unauthorized</li>
<li class="t-link" data-tab="3" role="tab" aria-selected="false" tabindex="0">404 Not Found</li>
</ul>
<div class="tab-views">



```json
[
  {
      "id": "406fefd4-8a36-4aee-880c-f3e4a928e27d",
      "status": "accepted",
      "device_id": "3919988"
  }
]

{
    "status": {
        "error": true,
        "code": 401,
        "type": "Unauthorized",
        "message": "Authentication Failure"
    }
}

{
    "statusCode": 404,
    "name": "NotFound",
    "message": "The resource can't be found or the server has not found anything matching the Request-URI"
}
```json

</div>
</div>


<h2>Response Elements</h2>
<table width="86%" cellpadding="10">
  <tbody>
        <tr>
        <td valign="top" style="text-align: right"><code>id</code></td>
        <td valign="top">Registration identifier. </td>
      </tr>
      <tr>
        <td valign="top" style="text-align: right"><code>status</code></td>
        <td valign="top"><code>pending</code> = has not been completed.  <code>accepted</code> registration has successfully completed, <code>rejected</code> user has denied the MFA attempt or incorrectly provided the OneLogin Voice OTP code.</td>
      </tr>
      <tr>
        <td valign="top" style="text-align: right"><code>device_id</code></td>
        <td valign="top">Device id to be used with <a href="/api-docs/2/multi-factor-authentication/verify-factor">Verify the Factor  </a>.</td>
      </tr>
  </tbody>
</table>

<h2 id="postman-collection">Postman Collection</h2>

[<img src=https://run.pstmn.io/button.svg alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/2629710-07192ad9-633a-4583-a9d1-47bc89c8c91d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D2629710-07192ad9-633a-4583-a9d1-47bc89c8c91d%26entityType%3Dcollection%26workspaceId%3D2a9bbc3a-4259-4faf-9f51-0b7ca1df3fd0)

<h2>Sample Code</h2>
<h3 id="sample-curl-request">cURL</h3>
<p>Replace sample values indicated by <code>&lt; &gt;</code> with your actual values.</p>

<pre><code class="prettyprint lang-c">curl 'https://&lt;subdomain&gt;.onelogin.com/api/2/mfa/users/&lt;user_id&gt;/verifications/&lt;verification_id&gt;' \
-X GET \
-H "Authorization: bearer &lt;access_token&gt;"
</code>
</pre>