Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Activates an entity/account in case , when the contract specifies that all new accounts are created inactive until activated by the userentities 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:
Status
colourGreen
titlePOST
URL:

/userentity/dp-keyid/{dpentity-keyid}/verify

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

 


 dp-keydialogportal™ master key 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:Optional

JSON data with code for verification.

Code Block
{
   "code": "1234"
}



Span
stylewhite-space:pre

Response body:


None
Status codes:204

Account The entity was verified with successsuccessfully verified


400

Request is valid but data validation failed

The following sub codes may be returned:

 

400
Contract requires code to verify account but verification code was not supplied
.4Mobile number is not unique (the mobile number belongs to an active entity - this includes entities that have not yet been verified)
400.5Mobile 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
Account was
Entity not found
 
404.2External entity could not be found



501

Account The entity can not be verified, either because the account entity does not require verification or because verification has already been carried outperformed.

The following sub codes may be returned:

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