DIVE Online API - Embedded App

The Embedded API endpoints allows the DIVE Online developer to view the status of currently pending verification sessions that were created using the Embedded App integration method.

api/v2/EmbeddedApp/Open/{id}

[POST] api/v2/EmbeddedApp/Open/{id}

Use Case - TODO: add use case description.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • id - The unique applicant/request ID for the embedded app session.

Optional Parameters

None

Request Body

None

Response Body

An HTTP response code will be a 200 value indicating the request has been opened.

Response Fields


api/v2/EmbeddedApp/IsOpen/{id}

[GET] /api/v2/EmbeddedApp/IsOpen/{id}

Use Case - Retrieve the status of a currently pending embedded app session by boolean value.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • id - The unique applicant/request ID for the embedded app session.

Optional Parameters

Response Body

{
   true
}

Response Fields

  • boolean - A boolean value indicating whether the embedded app session is currently open (true) or closed (false).

api/v2/EmbeddedApp/ValidationResponse/{applicantId}\{connectionId}

[GET] /api/v2/EmbeddedApp/ValidationResponse/{applicantId}/{connectionId}

Use Case - Retrieve the validation response attempt for a specific applicant and connection in an embedded app session.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • applicantId - The unique identifier for the applicant.
  • connectionId - The unique identifier for the connection.

Optional Parameters None

Response Body

TODO: Add example response body.

Response Fields TODO: Add response fields description.

api/v2/EmbeddedApp/Status/{id}

[GET] /api/v2/EmbeddedApp/Status/{id}

Use Case - Retrieve the status of a currently pending embedded app session. Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • id - The unique applicant/request ID for the embedded app session.

Optional Parameters None

Response Body

{
  3
}

Response Fields

  • integer - An integer value representing the current status of the embedded app session. Possible values are:
    • TODO: Add status code descriptions.

api/v2/EmbeddedApp/Close/{id}

[POST] /api/v2/EmbeddedApp/Close/{id}

Use Case - Closes a currently pending embedded app session.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • id - The unique applicant/request ID for the embedded app session.

Optional Parameters None

Request Body None

Response Body

An HTTP response code will be a 200 value indicating the request has been closed.

Response Fields

api/v2/EmbeddedApp/IsClosed/{id}

[GET] /api/v2/EmbeddedApp/IsClosed/{id}

Use Case - Retrieve the closed status of a currently pending embedded app session by boolean value.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

  • id - The unique applicant/request ID for the embedded app session.

Optional Parameters None

Response Body

{
   true
}

Response Fields

  • boolean - A boolean value indicating whether the embedded app session is currently closed (true) or open (false).