Revoke M-PIN ID

Revoke an identity.

# Endpoint Authentication

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

  Authorization: "Basic <base64(<YOUR_CLIENT_ID:YOUR_CLIENT_SECRET>)>"
  

# Parameters

# 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

# UNAUTHORIZED_REQUEST

The request needs to be authenticated with valid Client ID and Client Secret. For more information, see the Endpoint Authentication section above.

{
  "error": "UNAUTHORIZED_REQUEST",
  "info": "Access not allowed due to invalid credentials."
}

# 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."
}