Person

This is an object representing a person associated with an account.

  • address

    The customer's address.

    • city
      Type: string | null
      max length:  
      100

      City, district, suburb, town, or village.

    • country
      Type: string | null
      max length:  
      2

      Two-letter country code (ISO 3166-1 alpha-2).

    • line1
      Type: string | null
      max length:  
      100

      Address line 1 (e.g., street, PO Box, or company name).

    • line2
      Type: string | null
      max length:  
      100

      Address line 2 (e.g., apartment, suite, unit, or building).

    • postal_code
      Type: string | null
      max length:  
      100

      ZIP or postal code.

    • state
      Type: string | null
      max length:  
      100

      State, county, province, or region.

  • date_of_birth
    Type: object · DateOfBirth
    • day
      Type: integer | nullFormat: int32

      The day of birth, between 1 and 31.

    • month
      Type: integer | nullFormat: int32

      The month of birth, between 1 and 12.

    • year
      Type: integer | nullFormat: int32

      The four-digit year of birth.

  • email
    Type: string | null
    max length:  
    200

    The person's email address.

  • first_name
    Type: string | null
    max length:  
    200

    The person's first name.

  • last_name
    Type: string | null
    max length:  
    100

    The person's last name.

  • maiden_name
    Type: string | null
    max length:  
    100

    The person's maiden name.

  • metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      Type: string
  • nationality
    Type: string | null
    max length:  
    100

    The country where the person is a national.

  • phone
    Type: string | null
    max length:  
    100

    The person's phone number.

  • political_exposure
    Type: stringenum

    Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.

    values
    • existing
    • none
  • registered_address

    The customer's address.

    • city
      Type: string | null
      max length:  
      100

      City, district, suburb, town, or village.

    • country
      Type: string | null
      max length:  
      2

      Two-letter country code (ISO 3166-1 alpha-2).

    • line1
      Type: string | null
      max length:  
      100

      Address line 1 (e.g., street, PO Box, or company name).

    • line2
      Type: string | null
      max length:  
      100

      Address line 2 (e.g., apartment, suite, unit, or building).

    • postal_code
      Type: string | null
      max length:  
      100

      ZIP or postal code.

    • state
      Type: string | null
      max length:  
      100

      State, county, province, or region.

  • relationship
    Type: object · PersonRelationship
    • authorizer
      Type: boolean | null

      Whether the person is the authorizer of the account's representative.

    • director
      Type: boolean | null

      Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.

    • executive
      Type: boolean | null

      Whether the person has significant responsibility to control, manage, or direct the organization.

    • legal_guardian
      Type: boolean | null

      Whether the person is the legal guardian of the account's representative.

    • owner
      Type: boolean | null

      Whether the person is an owner of the account's legal entity.

    • percent_ownership
      Type: number | nullFormat: double

      The percent owned by the person of the account's legal entity.

    • representative
      Type: boolean | null

      Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.

    • title
      Type: string | null
      max length:  
      100

      The person's title (e.g., CEO, Support Engineer).