NovoPayment Customers API

---
openapi: 3.0.0
info:
  description: >
    The Customers API allows to handle the different type of customers
    that can be served by NovoPayment’s platform. This includes individuals,
    commercial and merchant customers. For most of the operations to be
    performed in the platform you will need to provide the customer id in order
    to complete the operation.


    Below operations are available for Customers API


    **Create Commercial Customers**


    This operation can be used for commercial customer creation.


    **Create Merchant Customers**


    This operation can be used to create a merchant customer type.


    **Create Individual Customers**


    This operation can be used to create an individual customer type.


    **Customer Employment Information Update**


    This operation updates the customer work information for the tenant´s administration staff.


    **Get Customer Action Logs**


    This operation allows to consult the list of actions carried out by the customer in all the options of the application.


    **Get Customer Risk Indicators**


    This operation allows to consult the customer's risk information studied by the anti-money laundering system (AML).


    **Get List of Customers**


    This operation allows to consult the information of all the customers that have registered into the system, these customers may have or may have not associated any account and card.


    **Get Supporting Documents**


    This operation allows to consult the list of support documents mandatories established by the tenant to validate the customer's profile (Utility bill, Proof of employment, etc.).


    **Get a Customer Document**


    This operation allows to consult one of the customer's support documents from a document id.
  version: v1
  title: Customers API
servers:
  - description: Sandbox
    url: https://sandbox-api.novopayment.com/customers/v1
paths:
  "/recipients/products/{productId}/decision":
    put:
      summary: Approve Or Decline A Recipient
      description: >
        Use the endpoint to approve or decline a recipient of a specific account.
      requestBody:
        $ref: "#/components/requestBodies/RQApproveOrDeclineARecipient"
      operationId: ApproveOrDeclineARecipient
      parameters:
        - $ref: "#/components/parameters/productId"
      responses:
        "200":
          $ref: "#/components/responses/RSApproveOrDeclineARecipient200"
        "400":
          $ref: "#/components/responses/RSApproveOrDeclineARecipient400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /commercial:
    post:
      summary: Create Commercial Customers
      description: |
        This operation can be used for commercial customer creation.
      requestBody:
        $ref: "#/components/requestBodies/RQCreateCommercialCustomers"
      operationId: CreateCommercialCustomers
      responses:
        "200":
          $ref: "#/components/responses/RSCreateCommercialCustomers200"
        "400":
          $ref: "#/components/responses/RSCreateCommercialCustomers400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /individuals:
    post:
      summary: Create Individual Customer
      description: >
        In cases where you are collecting and validating customer
        information for onboarding, the Create Individual Customer functionality
        is used to add all the onboarding information captured about a customer
        to NovoPayment’s databases. This functionality is for retail/consumer
        banking accounts.
      requestBody:
        $ref: "#/components/requestBodies/RQCreateIndividualCustomer"
      operationId: CreateIndividualCustomer
      responses:
        "200":
          $ref: "#/components/responses/RSCreateIndividualCustomer200"
        "400":
          $ref: "#/components/responses/RSCreateIndividualCustomer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /merchant:
    post:
      summary: Create Merchant Customers
      description: |
        Operation that allows to create a merchant type customer.
      requestBody:
        $ref: "#/components/requestBodies/RQCreateMerchantCustomer"
      operationId: CreateMerchantCustomers
      responses:
        "200":
          $ref: "#/components/responses/RSCreateMerchantCustomer200"
        "400":
          $ref: "#/components/responses/RSCreateMerchantCustomer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/employees":
    post:
      summary: Customer Employment Information Update
      description: >
        This operation updates the customer work information for the
        tenant´s administration staff.
      requestBody:
        $ref: "#/components/requestBodies/RQCustomerEmploymentInformationUpdate"
      operationId: CustomerEmploymentInformationUpdate
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSCustomerEmploymentInformationUpdate200"
        "400":
          $ref: "#/components/responses/RSCustomerEmploymentInformationUpdate400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/generalinfo":
    get:
      summary: Customer General Information
      description: |
        This operation returns the customer-general information.
      operationId: CustomerGeneralInformation
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSCustomerGeneralInformation200"
        "400":
          $ref: "#/components/responses/RSCustomerGeneralInformation400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  /customers:
    get:
      summary: Customer List
      description: |
        This operation allows to get the customer list registered in the system.
      operationId: CustomerList
      responses:
        "200":
          $ref: "#/components/responses/RSCustomerList200"
        "400":
          $ref: "#/components/responses/RSCustomerList400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/documents/{documentId}":
    get:
      summary: Get A Customer Document
      description: >
        This operation allows to consult one of the customer's support
        documents from a document id.
      operationId: GetACustomerDocument
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/documentId"
      responses:
        "200":
          $ref: "#/components/responses/RSGetACustomerDocument200"
        "400":
          $ref: "#/components/responses/RSGetACustomerDocument400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
    patch:
      summary: Update Customer Identity Documents
      description: |
        This operation allows to update a customer identity-specific document.

        This endpoint only updates the fields that are sent in the request body.
      requestBody:
        $ref: "#/components/requestBodies/RQUpdateCustomerIdentityDocuments"
      operationId: UpdateCustomerIdentityDocuments
      parameters:
        - $ref: "#/components/parameters/customerId"
        - $ref: "#/components/parameters/documentId"
      responses:
        "200":
          $ref: "#/components/responses/RSUpdateCustomerIdentityDocuments200"
        "400":
          $ref: "#/components/responses/RSUpdateCustomerIdentityDocuments400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/logs":
    get:
      summary: Get Customer Action Logs
      description: >
        This operation allows to consult the list of actions carried out by
        the customer in all the options of the application.
      operationId: GetCustomerActionLogs
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSGetCustomerActionLogs200"
        "400":
          $ref: "#/components/responses/RSGetCustomerActionLogs400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/risks":
    get:
      summary: Get Customer Risk Indicators
      description: >
        This operation allows to consult the customer's risk information
        studied by the anti-money laundering system (AML).
      operationId: GetCustomerRiskIndicators
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSGetCustomerRiskIndicators200"
        "400":
          $ref: "#/components/responses/RSGetCustomerRiskIndicators400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/documents":
    get:
      summary: Get Supporting Documents
      description: >
        This operation allows to consult the list of support documents
        mandatories established by the tenant to validate the customer's profile
        (Utility bill, Proof of employment, etc.).
      operationId: GetSupportingDocuments
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSGetSupportingDocuments200"
        "400":
          $ref: "#/components/responses/RSGetSupportingDocuments400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}/unsubscribe":
    post:
      summary: Unsubscribe Customer
      description: >
        This operation allows to unsubscribe a customer. This operation
        cannot be undone.
      requestBody:
        $ref: "#/components/requestBodies/RQUnsubscribeCustomer"
      operationId: UnsubscribeCustomer
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSUnsubscribeCustomer200"
        "400":
          $ref: "#/components/responses/RSUnsubscribeCustomer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
  "/customers/{customerId}":
    patch:
      summary: Update Customer
      description: |
        This operation allows to update customer-specific information.

        This endpoint only updates the fields that are sent in the request body.
      requestBody:
        $ref: "#/components/requestBodies/RQUpdateCustomer"
      operationId: UpdateCustomer
      parameters:
        - $ref: "#/components/parameters/customerId"
      responses:
        "200":
          $ref: "#/components/responses/RSUpdateCustomer200"
        "400":
          $ref: "#/components/responses/RSUpdateCustomer400"
        "401":
          $ref: "#/components/responses/RS401"
        "500":
          $ref: "#/components/responses/RS500"
security:
  - oAuth2ClientCredentials: []
components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: >
        See [Oauth2
        API](https://developer.novopayment.com/api/authentication-method-and-encryption/oauth2-api)
      flows:
        clientCredentials:
          tokenUrl: https://sandbox-api.novopayment.com/oauth2/token
          scopes: {}
  examples:
    HeaderParamsRequired:
      value:
        code: 400.18.001
        message: Header Params Required
        datetime: "2020-01-03T16:05:56.517Z"
    RequestParamsRequired:
      value:
        code: 400.18.003
        message: Params required
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidAccessToken:
      value:
        code: 401.18.990
        message: Invalid Access Token
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenNotApproved:
      value:
        code: 401.18.991
        message: Access Token not approved
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidSignature:
      value:
        code: 401.18.992
        message: Invalid signature
        datetime: "2020-01-03T16:05:56.517Z"
    AccessTokenExpired:
      value:
        code: 401.18.993
        message: Access token expired
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidTenantId:
      value:
        code: 400.18.004
        message: Invalid tenant ID
        datetime: "2020-01-03T16:05:56.517Z"
    InternalServerError:
      value:
        code: 500.18.001
        message: Internal Server Error
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerNotFound:
      value:
        code: 400.18.382
        message: Customer not found
        datetime: "2020-01-03T16:05:56.517Z"
    ParameterFormatError:
      value:
        code: 400.18.081
        message: Parameter format error
        datetime: "2020-01-03T16:05:56.517Z"
    OFACRecordFound:
      value:
        code: 400.18.108
        message: OFAC record found
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedResourceNotFound:
      value:
        code: 400.18.022
        message: The requested resource was not found.
        datetime: "2020-01-03T16:05:56.517Z"
    InvalidData:
      value:
        code: 400.18.089
        message: Invalid data.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedProductNotExist:
      value:
        code: 400.18.068
        message: It is not possible to obtain information about the requested product.
        datetime: "2020-01-03T16:05:56.517Z"
    DatabaseError:
      value:
        code: 400.18.020
        message: Database result was ok, but it was not possible recognize data base
          response.
        datetime: "2020-01-03T16:05:56.517Z"
    GeneralError:
      value:
        code: 400.18.021
        message: Something unexpected has happened, please try again.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestNotFound:
      value:
        code: 400.18.025
        message: We can not find what youre looking for.
        datetime: "2020-01-03T16:05:56.517Z"
    OpenEscalationsExist:
      value:
        code: 400.18.035
        message: Open escalations exist.
        datetime: "2020-01-03T16:05:56.517Z"
    ProductStatusNotUpdated:
      value:
        code: 400.18.317
        message: Product status could not be updated.
        datetime: "2020-01-03T16:05:56.517Z"
    UsernameUsed:
      value:
        code: 400.18.063
        message: Someone else already has this username.
        datetime: "2020-01-03T16:05:56.517Z"
    RegisteredUserWithThatEmail:
      value:
        code: 400.18.065
        message: There is already a registered user with that email.
        datetime: "2020-01-03T16:05:56.517Z"
    AllowedAPrimaryDocument:
      value:
        code: 400.18.411
        message: Only one primary document is allowed.
        datetime: "2020-01-03T16:05:56.517Z"
    ThereIsNoMainDocument:
      value:
        code: 400.18.412
        message: There is more than one identity document present in the list, but none
          of them is marked as primary.
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerNotSaved:
      value:
        code: 400.18.418
        message: The customer could not be saved.
        datetime: "2020-01-03T16:05:56.517Z"
    NoSearchResultsWereFound:
      value:
        code: 400.18.343
        message: No search results were found.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedDocumentNotUploaded:
      value:
        code: 400.18.390
        message: The requested document has not been uploaded yet.
        datetime: "2020-01-03T16:05:56.517Z"
    PersonNotRegistered:
      value:
        code: 400.18.055
        message: This person is not registered.
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerHasOpenAccounts:
      value:
        code: 400.18.420
        message: Customer has open accounts.
        datetime: "2020-01-03T16:05:56.517Z"
    CustomerStatusNotAllowed:
      value:
        code: 400.18.027
        message: Customer status is not allowed for this action.
        datetime: "2020-01-03T16:05:56.517Z"
    DocumentNumberExist:
      value:
        code: 400.18.405
        message: Document number already exist.
        datetime: "2020-01-03T16:05:56.517Z"
    PrimaryIdentityDocumentRequired:
      value:
        code: 400.18.422
        message: Customer must have at least one primary identity document.
        datetime: "2020-01-03T16:05:56.517Z"
    RequestedIdentityDocumentNotExist:
      value:
        code: 400.18.423
        message: The requested identity document does not exist or does not belong to
          the customer.
        datetime: "2020-01-03T16:05:56.517Z"
  parameters:
    productId:
      name: productId
      in: path
      description: A unique identifier that associates the data from the product with
        the recipient.
      required: true
      schema:
        type: integer
        example: 221BF87320F278DC9F41C835AD0D5111B2B0FF68
        maxLength: 38
    customerId:
      name: customerId
      in: path
      description: Unique customer identifier.
      required: true
      schema:
        type: string
        example: 69E2DBE6B18C7ACD
        maxLength: 40
    documentId:
      name: documentId
      in: path
      required: true
      schema:
        type: string
        example: 2
    documentTypeId:
      name: documentTypeId
      in: query
      required: false
      schema:
        type: string
        example: 3
    statusId:
      name: statusId
      in: query
      required: false
      schema:
        type: string
        enum:
          - active
          - inactive
    top:
      name: top
      in: query
      required: false
      schema:
        type: string
        example: 4
    fromCreatedDate:
      name: fromCreatedDate
      in: query
      required: false
      schema:
        type: string
        example: 2021/01/29 10:53:54
    toCreatedDate:
      name: toCreatedDate
      in: query
      required: false
      schema:
        type: string
        example: 2021/01/29 10:53:54
    documentNumber:
      name: documentNumber
      in: query
      required: false
      schema:
        type: string
        example: C96485632
    firstNames:
      name: firstNames
      in: query
      required: false
      schema:
        type: string
        example: Jhon
    lastNames:
      name: lastNames
      in: query
      required: false
      schema:
        type: string
        example: Doe
    documentIso2:
      name: documentIso2
      in: query
      required: true
      schema:
        type: string
        example: US
    fromReviewDate:
      name: fromReviewDate
      in: query
      required: false
      schema:
        type: string
        example: 2021/01/29 10:53:54
    toReviewDate:
      name: toReviewDate
      in: query
      required: false
      schema:
        type: string
        example: 2021/01/29 10:53:54
  schemas:
    RQApproveOrDeclineARecipient:
      type: object
      required:
        - actionId
        - comments
        - updatedBy
      properties:
        actionId:
          type: integer
          description: |
            Action to perform

            **Allowed values:**

            0: Decline

            1: Approve
          enum:
            - 0
            - 1
          maxLength: 200
        comments:
          type: string
          description: Comments related to the action.
          example: Invalid Recipient.
          maxLength: 200
        updatedBy:
          type: string
          description: The user who performs the action.
          example: Master
          maxLength: 100
    RQCreateCommercialCustomers:
      type: object
      required:
        - legalName
        - tradingName
        - industryType
        - entityType
        - entityPurpose
        - registrationNumber
        - incorporationDate
        - identifications
        - webSite
        - contacts
        - addresses
      properties:
        legalName:
          type: string
          description: >
            Entity legal name as mentioned in official documentation.


            __*Only letters, numbers and the following special characters are allowed: dash, apostrophes, period, coma and spaces.__
          example: commercial LegalName
          maxLength: 50
        tradingName:
          type: string
          description: >
            Entity commercial name as mentioned in official documentation.


            __*Only letters, numbers and the following special characters are allowed: dash, apostrophes, period, coma and spaces.__
          example: commercial Trading Name
          maxLength: 50
        industryType:
          type: string
          description: >
            Industry Type.


            **Refer to:** [Industry Type](https://developer.novopayment.com/api/request-and-response-codes#item-industrytype)
          example: 44122
          maxLength: 50
        entityType:
          type: string
          description: >
            Entity Type.


            **Refer to:** [Entity Type](https://developer.novopayment.com/api/request-and-response-codes#item-entitytype)
          example: UNIQUE OWNER
          maxLength: 50
        entityPurpose:
          type: string
          description: Entity Purpose Description.
          example: commercial Purpose.
          maxLength: 50
        registrationNumber:
          type: string
          description: Tax id number or tax record number of the business.
          example: 9834092375230
          maxLength: 50
        incorporationDate:
          type: string
          description: |
            Operation timestamp expressed in ISO 8601.
          example: "2020-01-03T16:05:56.517Z"
          maxLength: 50
        identifications:
          type: array
          description: >
            Array allows to add more than one business id to a business
            BUSINESS_TAX_ID BUSINESS_NUMBER TAXPAYER_IDENTIFICATION_NUMBER.
          required:
            - type
            - value
          items:
            type: object
            properties:
              type:
                type: string
                description: >
                  Identification.


                  *Format:* BUSINESS_TAX_ID, BUSINESS_NUMBER o TAXPAYER_IDENTIFICATION_NUMBER
                enum:
                  - BUSINESS_TAX_ID
                  - BUSINESS_NUMBER
                  - TAXPAYER_IDENTIFICATION_NUMBER
                maxLength: 50
              value:
                type: string
                description: |
                  Identification number associated to the format.
                example: XX-XXXXXXX
                maxLength: 50
        webSite:
          type: string
          description: Company website.
          example: https://by.com
          maxLength: 50
        contacts:
          type: array
          description: An array containing contact information.
          required:
            - type
            - value
          items:
            type: object
            properties:
              type:
                type: string
                description: A standard set of values that indicate the contact type [EMAIL,
                  PHONE].
                enum:
                  - EMAIL
                  - PHONE
                maxLength: 50
              value:
                type: string
                description: >
                  If type is 'email', string must be match email format, the '+'
                  character is not allowed. If type is 'phone', string must be
                  in an international format, the + symbol and the 1-3 digit
                  country calling code.
                example: email@email.com
                maxLength: 50
        addresses:
          type: array
          description: >
            An array containing business's addresses; Address should follow
            USPS normalization practices (Example: "St" instead of "street",
            common unit designator "APT" instead of "apartment"). Periods "."
            are not allowed. Zip+4 is not required.
          required:
            - addressType
          items:
            type: object
            properties:
              addressType:
                type: string
                description: Address type.
                example: RESIDENCE
                maxLength: 20
              addressLine1:
                type: string
                description: Address Line One.
                example: address line 1
                maxLength: 100
              addressLine2:
                type: string
                description: Address Line Two.
                example: address line 2
                maxLength: 100
              homeNumber:
                type: string
                description: House number.
                example: Office 124
                maxLength: 50
              buildingNumber:
                type: string
                description: Building number.
                example: Building C
                maxLength: 50
              city:
                type: string
                description: City.
                example: New York
                maxLength: 100
              zipCode:
                type: string
                description: ZIP code.
                example: 94398
                maxLength: 10
              country:
                type: string
                description: Country in ISO code 2 digits.
                example: US
                maxLength: 2
    RQCreateIndividualCustomer:
      type: object
      required:
        - generalInformation
        - identityDocumentList
        - personalAddress
        - contactInformation
      properties:
        userCredentials:
          type: object
          description: Customized object contains the user credentials information.
          properties:
            username:
              type: string
              description: Username in the application.
              example: JDOE
              maxLength: 20
            password:
              type: string
              description: Encrypted user password in the application.
              example: SDFSD890V131MNHJK543ER32SD
              maxLength: 50                      
        generalInformation:
          type: object
          description: Customized object contains the general information customer.
          required:
            - firstNames
            - lastNames
            - civilStatus
            - birthCountry
          properties:
            firstNames:
              type: string
              description: Customer first name.
              example: John
              maxLength: 50
            lastNames:
              type: string
              description: Customer last name.
              example: Doe
              maxLength: 50
            isPep:
              type: boolean
              description: Is a person politically exposed person?
              example: true
            gender:
              type: object
              description: Customized object contains the gender information.
              required:
                - id
              properties:
                id:
                  type: string
                  description: >
                    **Refer to:**
                    [Gender](https://developer.novopayment.com/api/request-and-response-codes#item-gender)
                  example: 1
                  maxLength: 5
            civilStatus:
              type: object
              description: Customized object contains the civil status information.
              required:
                - id
              properties:
                id:
                  type: string
                  description: >
                    __**Refer to:** [Civil
                    Status](https://developer.novopayment.com/api/request-and-response-codes#item-civilstatus)__
                  example: 1
                  maxLength: 5
            birthCountry:
              type: object
              description: Customized object contains the country information.
              required:
                - iso2
              properties:
                iso2:
                  type: string
                  description: >
                    **Refer to:** [ISO Country
                    Codes](https://developer.novopayment.com/api/request-and-response-codes#item-isocountrycodes)
                  example: US
                  maxLength: 2
            birthState:
              type: object
              description: Customized object contains the state information.
              properties:
                name:
                  type: string
                  description: Customer birth state name.
                  example: New York
                  maxLength: 100
            birthCity:
              type: object
              description: Customized object contains the city information.
              properties:
                name:
                  type: string
                  description: Customer birth city.
                  example: New York
                  maxLength: 100
            birthDate:
              type: string
              description: Customer birth Date.
              example: 1985/01/07
              maxLength: 50
            educationLevel:
              type: object
              description: Customized object contains the education level information.
              properties:
                id:
                  type: string
                  description: >
                    **Refer to:** [Education
                    Level](https://developer.novopayment.com/api/request-and-response-codes#item-educationlevel)
                  example: 1
                  maxLength: 50
        identityDocuments:
          type: array
          description: Customized object contains the identity document list information
            customer.
          required:
            - documentType
            - documentNumber
            - isPrimary
          items:
            type: object
            properties:
              documentType:
                type: object
                description: Customized object contains the document type information.
                required:
                  - id
                properties:
                  id:
                    type: string
                    description: >
                      **Refer to:** [Document
                      Type](https://developer.novopayment.com/api/request-and-response-codes#item-documenttype)
                    example: 3
                    maxLength: 5
              documentNumber:
                type: string
                description: Customer document number.
                example: C96485632
                maxLength: 25
              isPrimary:
                type: boolean
                description: |
                  It is your main document.

                  **Possible values:**

                  True: if it is a primary document.

                  False: Not is a primary document.
                example: true
              issueDate:
                type: string
                description: Document issue date.
                example: 2020/01/01
              expirationDate:
                type: string
                description: Document expiration Date.
                example: 2030/01/01
              country:
                type: object
                description: Customized object contains the document country level information.
                required:
                  - iso2
                properties:
                  iso2:
                    type: string
                    description: >
                      **Refer to:** [ISO Country
                      Codes](https://developer.novopayment.com/api/request-and-response-codes#item-isocountrycodes)
                    example: US
                    maxLength: 2
              firstNames:
                type: string
                description: Document firsts names.
                example: John
                maxLength:

# --- truncated at 32 KB (150 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/novopayment/refs/heads/main/openapi/novopayment-customers-openapi.yml