Creates a third-party account holder

Creates a new third-party account holder and associates it to the tenant.

Authorization

authorization

AuthorizationBearer <token>

In: header

Header Parameters

x-idempotency-key?string

Idempotency key in UUID format

Formatuuid

Example"f30f1d0b-795f-49f5-80dc-41a7bffccfde"

Request Body

application/json

Attributes to create a third-party account holder

addressAddress

Contains the address information related to the account holder.

email?string|null

Account holder's email

Match^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+){1,2}$

Formatemail

Example"someone@gmail.com"

external_idstring|null

Represents a unique external_id generated and provided by the API user. The API user is responsible to generate and provide a unique id for all their organization's account holders.

Example"00001"

metadata?object|null

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

personobject

Contains the specific person information of the account holder.

phone_number?string|null

Account holder's phone number

Match^\+[1-9]\d{1,14}$

Example"+573000000000"

Response Body

application/json

curl -X POST "https://api.cert.monoban.co/v1/ledger/account_holders" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "city": "Chapinero",
      "country": "CO",
      "line_1": "Calle 97 # 15-24",
      "state": "Bogota D.C",
      "zip_code": "110221"
    },
    "external_id": "00001",
    "person": {
      "country_code": "CO",
      "document_number": "00321",
      "document_type": "CC",
      "first_name": "John",
      "last_name": "Doe",
      "person_type": "natural"
    }
  }'

curl -X POST "https://api.cert.monoban.co/v1/ledger/account_holders" \  -H "Content-Type: application/json" \  -d '{    "address": {      "city": "Chapinero",      "country": "CO",      "line_1": "Calle 97 # 15-24",      "state": "Bogota D.C",      "zip_code": "110221"    },    "external_id": "00001",    "person": {      "country_code": "CO",      "document_number": "00321",      "document_type": "CC",      "first_name": "John",      "last_name": "Doe",      "person_type": "natural"    }  }'

{
  "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"
}

{
  "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"
}

Creates a third-party account holder

Authorization

Header Parameters

Request Body

Response Body

200application/json

201application/json

400application/json

401application/json

403application/json

422application/json

application/json

application/json

application/json

application/json

application/json

application/json