2004: Verify account

Activates an entity/account, when the contract specifies that all new entities must be verified before they can be used.

This endpoint is also used to complete entity updates which require verification, such as updating a mobile number for an SMS-verified entity.

Endpoint ID:

2004

Method:

POST

URL:

/entity/id/{entity-id}/verify

/entity/ext-key/{ext-key}/{ext-type}/verify

entity-id

Rubiq entity ID that uniquely identifies an account to verify

ext-key

External key that uniquely identifies an account to verify

ext-type

Type of external key

Request body:

JSON data with code for verification.

{
   "code": "1234"
}

Response body:

None

Status codes:

204

The entity was successfully verified

400

Request is valid but data validation failed

The following sub codes may be returned:

400.4	Mobile number is not unique (the mobile number belongs to an active entity - this includes entities that have not yet been verified)
400.5	Mobile number is not unique (the mobile number belongs to an inactive entity)

403

Verification code doesn’t match the code stored in the database

404

The entity was not found

The following sub codes may be returned:

404.1	Entity not found
404.2	External entity could not be found

501

The entity can not be verified, either because the entity does not require verification or because verification has already been performed.

The following sub codes may be returned:

501.2	Entity does not need to be verified
501.3	Entity has not been assigned a verification code

REST API