com.virgilsecurity.sdk.client.service

Interface IdentityService

public interface IdentityService

This interface represents Virgil Identity HTTP API.

Author:

Andrii Iakovenko

Method Summary

Methods

Modifier and Type	Method and Description
retrofit2.Call<ValidatedIdentity>	confirm(Confirmation confirmation) Confirms identity from the /verify step to obtain an identity confirmation token Request info.
retrofit2.Call<Void>	validate(ValidatedIdentity identity) Validates the passed token.
retrofit2.Call<Action>	verify(Identity identity) Initiates the process to verify the Identity Request info.

Method Detail

verify

@POST(value="/v1/verify")
retrofit2.Call<Action> verify(@Body
                                 Identity identity)

Initiates the process to verify the Identity Request info.

Parameters:

identity - the identity for verification.

Returns:

See Also:

Identity, Action, Call

confirm

@POST(value="/v1/confirm")
retrofit2.Call<ValidatedIdentity> confirm(@Body
                                             Confirmation confirmation)

Confirms identity from the /verify step to obtain an identity confirmation token Request info.

Parameters:

confirmation - the confirmation data.

Returns:

See Also:

Confirmation, ValidatedIdentity, Call

validate

@POST(value="/v1/validate")
retrofit2.Call<Void> validate(@Body
                                 ValidatedIdentity identity)

Validates the passed token.

Parameters:

identity - the identity for validation. The token should be defined.

Returns:

See Also:

Confirmation, ValidatedIdentity