Customers

Create customer

Create a new account customer.

There are 3 customer types you can create with this endpoint: a company customer, a person customer, or a person customer with less informational fields (customer object).

Each account contains at least one customer. You can add multiple customers to an account but only one can be the account owner. Other customers can have their own individual cards, but the balances on those cards must be shared with the account owner.

This endpoint generates a Customer created event.

If the customer.is_owner property is set to true:

The account owner is changed to this new customer, and all existing customers remain active in the account.
This endpoint generates an Account owner changed event.

If the customer.is_active = true, and the Maximum number of card holders program parameter is set, this customer is counted in the limit of maximum number of card holders for an account.

Each customer has an associated entity object. If one isn't passed in the request, a default one is created using their document number.

Refer to the Core objects guide for more information.

post/accounts/v2/customers

Request

Base URL
https://sandbox.pismolabs.io
URL
https://sandbox.pismolabs.io/accounts/v2/customers
Auth
HTTP bearer

Request body

account_idinteger required

Account ID

Example request

{
  "account_id": 1001,
  "entity": {
    "name": "Sam Smith",
    "document_number": "31457828046",
    "birth_date": "15/01/1990",
    "gender": "M",
    "marital_status": "MARRIED",
    "mothers_name": "Kay Sadilla",
    "registration": "55555555",
    "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f",
    "person": {
      "nationality": "Australian",
      "city_of_birth": "San Diego",
      "state_of_birth": "California",
      "country_of_birth": "India",
      "other_id_number": "29000000",
      "document_issued_at": "Brazil",
      "document_issued_date": "01/31/1970",
      "fathers_name": "Steven Douglas",
      "occupation": "Programmer",
      "assets": 40000,
      "income": 2000,
      "net_worth": 50000
    },
    "company": {
      "company_name": "Acme Inc.",
      "registration_number": "ACM10004",
      "activity": "Manufacturing",
      "company_type": "Retailer",
      "company_format": "ME",
      "company_constitution_date": "01/01/2019",
      "occupation": "CEO",
      "annual_revenues": 33000,
      "type": "B2C",
      "number_of_partners": 3,
      "perc_ownership": 50,
      "fiscal_situation": "Good",
      "debt": 18000,
      "income": 10000,
      "net_worth": 20000,
      "partners": [
        {
          "name": "Hyman Roth",
          "nickname": "Pinto",
          "printed_name": "Jack Williams",
          "social_name": "Jack",
          "email": "jenna.flect@email.com",
          "document_number": "31457828046",
          "mothers_name": "Kay Sadilla",
          "gender": "M",
          "birth_date": "31/12/1980",
          "city_of_birth": "San Diego",
          "state_of_birth": "California",
          "country_of_birth": "India",
          "fathers_name": "Steven Douglas",
          "marital_status": "MARRIED"
        }
      ]
    }
  },
  "customer": {
    "email": "jenna.flect@email.com",
    "printed_name": "Jack Williams",
    "social_name": "Jack",
    "nickname": "Pinto"
  }
}

Response

Account additional registration

account_idinteger

Account ID

external_idstring

Client-created ID from an external system or application. REQUIRED for VIRTUAL accounts.

customer_idinteger

Customer ID

entitydinteger

Entity ID

messagestring

is_migrationboolean

Is this a customer migration?

Example response

{
  "account_id": 1001,
  "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f",
  "customer_id": 100211299,
  "entityd": 1234567891,
  "message": "Customer registration response (201 created)",
  "data": {
    "entity": {
      "name": "Sam Smith",
      "gender": "M",
      "registration": "55555555",
      "marital_status": "MARRIED",
      "mothers_name": "Kay Sadilla",
      "birth_date": "15/01/1990",
      "document_number": "31457828046",
      "person": {
        "name": "Hyman Roth",
        "nickname": "Pinto",
        "printed_name": "Luce Lyons",
        "social_name": "Jack",
        "email": "jenna.flect@email.com",
        "gender": "M",
        "marital_status": "MARRIED",
        "mothers_name": "Kay Sadilla",
        "nationality": "Australian",
        "city_of_birth": "San Diego",
        "state_of_birth": "California",
        "country_of_birth": "India",
        "other_id_number": "29000000",
        "document_issued_at": "Brazil",
        "document_issued_date": "01/31/1970",
        "fathers_name": "Steven Douglas",
        "occupation": "Programmer",
        "assets": 40000,
        "income": 2000,
        "net_worth": 50000
      },
      "company": {
        "name": "Sam Houston",
        "nickname": "Curveball",
        "printed_name": "Luce Lyons",
        "social_name": "Otter",
        "company_name": "Acme Inc.",
        "registration_number": "ACM10004",
        "activity": "Manufacturing",
        "company_type": "Retailer",
        "company_format": "ME",
        "occupation": "CEO",
        "income": 10000,
        "net_worth": 20000,
        "annual_revenues": 33000,
        "type": "B2C",
        "number_of_partners": 3,
        "perc_ownership": 50,
        "fiscal_situation": "Good",
        "debt": 18000,
        "email": "acme@acmemail.com",
        "partners": [
          {
            "name": "Hyman Roth",
            "nickname": "Pinto",
            "printed_name": "Jack Williams",
            "social_name": "Jack",
            "email": "jenna.flect@email.com",
            "document_number": "31457828046",
            "mothers_name": "Kay Sadilla",
            "gender": "M",
            "birth_date": "31/12/1980",
            "city_of_birth": "San Diego",
            "state_of_birth": "California",
            "country_of_birth": "India",
            "fathers_name": "Steven Douglas",
            "marital_status": "MARRIED"
          }
        ]
      }
    },
    "external_id": "8c8a4dd7-e48f-4c15-85b7-9d12f401057f"
  },
  "customer": {
    "nickname": "Pinto",
    "printed_name": "Jack Williams",
    "social_name": "Jack",
    "is_active": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.