Revoke M-PIN ID

Revoke an identity.

Endpoint	Supported methods	Full URL
/api/v1/projects/<PROJECT_ID>/mpinids/{mpinId}/revocation	POST	api.mpin.io/api/v1/projects/<PROJECT_ID>/mpinids/{mpinId}/revocation

# Endpoint Authentication

Basic - The client ID and secret are used as a username:password pair for the HTTP Basic authentication of the request.

# Parameters

Name	Type	Required	Description
projectId	Path	True	Project ID
mpinId	Path	True	M-PIN ID to be revoked
reason	Body	False	Reason for the revocation

# Request Example

curl \
  --request POST \
  --user "${YOUR_CLIENT_ID}:${YOUR_CLIENT_SECRET}" \
  --data '{
    "reason":"account expiration"
  }' \
  "https://api.mpin.io/api/v1/projects/${YOUR_PROJECT_ID}/mpinids/${MPIN_ID}/revocation"

# Response Example

{
  "hashMPinID": "<MPIN_ID>",
  "reason": "account expiration"
}

# Errors

# INVALID_REQUEST_PARAMETERS

Missing or invalid parameters from the request. You can see the affected parameter(s) in the context of the error. For information about the possible parameters, see the Parameters section above.

{
  "error": "INVALID_REQUEST_PARAMETERS",
  "info": "Missing or invalid parameters from the request.",
  "context": {
    "params": "projectId"
  }
}

# INVALID_REQUEST_PAYLOAD

Request payload doesn’t match the schema. For information about the possible parameters, see the Parameters section above.

{
  "error": "INVALID_REQUEST_PAYLOAD",
  "info": "Request payload doesn't match schema."
}

# INVALID_REQUEST_BODY

The request payload needs to be a valid JSON.

{
  "error": "INVALID_REQUEST_BODY",
  "info": "The request payload is invalid JSON."
}