Mono Colombia

Updates a third-party account holder

Updates a third-party account holder

PATCH
/v1/ledger/account_holders/{id}

Authorization

authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Account Holder ID (Base 62 format)

Match^[A-Za-z]{2,6}_[\w-]{22}$
Example"acch_5tgliBmzjZ6mpQPRbQjfKj"

Request Body

application/json

Attributes to update a third-party account holder

detail?string|null

It provides a textual reason why the account holder is blocked in case of the state_reason value is other.

Example"breach of terms"
email?string

Account holder's email

Match^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+){1,2}$
Formatemail
Example"someone@gmail.com"
metadata?object

A tenant-managed flat map for providing additional data about the account holder. The values are stored and displayed as strings, and the provided information will be returned as-is in the account holder details.

Example{ "hello": "world" }
phone_number?string

Account holder's phone number

Match^\+[1-9]\d{1,14}$
Example"+573001000000"
reason?string|null

It provides the reason why the account holder could be blocked. It is required when the account holder is transitioned to being blocked.

Value in"fraud" | "user_request" | "other"
Example"fraud"
state?string

It represents the current state of the account holder, and these are the possible states of an account holder:

  • active: it is enable to manage and perform actions with its accounts.
  • blocked: it is blocked by the tenant, but you could also make it active again.
Value in"active" | "blocked"
Example"blocked"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.cert.monoban.co/v1/ledger/account_holders/acch_5tgliBmzjZ6mpQPRbQjfKj" \  -H "Content-Type: application/json" \  -d '{}'
{
  "address": {
    "city": "Chapinero",
    "country": "CO",
    "extra": "Location near the southeast corner in front of the ABC mall. deliver to the security guard pedro pruebas",
    "line_1": "Calle 97 # 15-24",
    "line_2": "Apto. 208",
    "state": "Bogota D.C",
    "zip_code": "110221"
  },
  "email": "someone@gmail.com",
  "external_id": "00001",
  "id": "acch_5tgliBmzjZ6mpQPRbQjfKj",
  "inserted_at": "2022-01-01T01:00:00Z",
  "metadata": {
    "hello": "world"
  },
  "person": {
    "country_code": "CO",
    "document_number": "00321",
    "document_type": "CC",
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Tyler",
    "person_type": "natural",
    "second_last_name": "Lucas"
  },
  "phone_number": "+573000000000",
  "state": "active",
  "state_reason": "fraud",
  "state_reason_detail": "string",
  "type": "self",
  "updated_at": "2022-01-01T01:00:00Z"
}
{
  "code": "400 Bad Request",
  "errors": [
    {
      "error_code": "validation_error",
      "message": "Generic changeset errors",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Malformed request"
}
{
  "code": "401 Unauthorized",
  "errors": [
    {
      "error_code": "expired_token",
      "message": "The token is expired, inactive, or doesn't exist.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Authorization header is missing or invalid."
}
{
  "code": "403 Forbidden",
  "errors": [
    {
      "error_code": "not_authorized",
      "message": "Not authorized to have access to this resource.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Not authorized to have access to this resource"
}
{
  "code": "422 Unprocessable Entity",
  "errors": [
    {
      "error_code": "missing_field",
      "message": "The field is missing on the request body or parameters.",
      "path": "#/path/to/field",
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Validation errors"
}