Create Customer

POST /customers
Authorization

Body Required

  • nickName string Required
  • firstName string Required
  • lastName string Required
  • email string Required
  • maritalString string Required
  • mothersFullName string Required
  • birthDate string Required
  • mailingAddress string Required
  • mailingAddressCountry string Required
  • mailingAddressZipCode string Required
  • mailingAddressStreet string Required
  • mailingAddressNumber string Required
  • mailingAddressComplement string Required
  • mailingAddressNeighborhood string Required
  • mailingAddressCity string Required
  • mailingAddressState string Required
  • currentlyWorking string Required
  • busyAttorneyAccount string Required
  • includeCarrierAccount string Required
  • residentialOtherCountry string Required
  • linkedPI string Required
  • politicallyExposed string Required
  • usPerson string Required
  • hasAssets string Required
  • otherEquity number Required
  • equityInvestments number Required
  • realEstate number Required
  • automobileHeritage string Required
  • doc_type string Required
  • document string Required
  • nationality string Required
  • phone string Required
  • telephone string Required
  • rg string Required
  • dateOfIssue string Required
  • dispatchingOrgan string Required
  • issuingState string Required
  • fathersFullName string Required
  • spouse string Required
  • documentSpouse string Required
  • cityBorn string Required
  • zipCode string Required
  • address string Required
  • numberAddress string Required
  • complementAddress string Required
  • neighborhood string Required
  • cityAddress string Required
  • country string Required
  • companyName string Required
  • occupationArea string Required
  • profession string Required
  • informedProfession string Required
  • monthlyIncome number Required
  • equityValue string Required
  • countryOfBirth string Required
  • stateBorn string Required
  • status number Required
  • stateAddress string Required
  • withoutDiscretionaryManagement boolean Required
  • gender string Required
  • ibgeCode string Required
  • mailingAddressIbgeCode string Required

Responses

  • 200
    Hide response attribute Show response attribute object
    • createCustomer array[object] Required
      Hide createCustomer attributes Show createCustomer attributes array[object]
      • id string Required
      • zipCode string Required
      • gender string Required
      • document string Required
      • companyName string Required
      • stateAddress string Required
      • mothersFullName string Required
      • hasAssets string Required
      • automobileHeritage string Required
      • realEstate string Required
      • equityInvestments string Required
      • otherEquity string Required
      • equityValue string Required
      • occupationArea string Required
      • countryOfBirth string Required
      • stateBorn string Required
      • currentlyWorking string Required
      • cityAddress string Required
      • informedProfession string Required
      • email string Required
      • monthlyIncome string Required
      • profession string Required
      • address string Required
      • maritalString string Required
      • firstName string Required
      • lastName string Required
      • cityBorn string Required
      • birthDate string Required
      • nationality string Required
      • phone string Required
      • mailingAddress string Required
      • PEP string Required
      • numberAddress string Required
      • neighborhood string Required
      • status string Required
      • fees array[object] Required
        Hide fees attributes Show fees attributes array[object]
        • discount number Required
        • type string Required
        • paymentDay number Required
        • begin string Required
  • 401
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 400
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 422
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
POST /customers 
curl \
 -X POST https://open-api.hml.soupi.com.br/customers \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"nickName":"string","firstName":"string","lastName":"string","email":"string","maritalString":"string","mothersFullName":"string","birthDate":"string","mailingAddress":"string","mailingAddressCountry":"string","mailingAddressZipCode":"string","mailingAddressStreet":"string","mailingAddressNumber":"string","mailingAddressComplement":"string","mailingAddressNeighborhood":"string","mailingAddressCity":"string","mailingAddressState":"string","currentlyWorking":"string","busyAttorneyAccount":"string","includeCarrierAccount":"string","residentialOtherCountry":"string","linkedPI":"string","politicallyExposed":"string","usPerson":"string","hasAssets":"string","otherEquity":42.0,"equityInvestments":42.0,"realEstate":42.0,"automobileHeritage":"string","doc_type":"string","document":"string","nationality":"string","phone":"string","telephone":"string","rg":"string","dateOfIssue":"string","dispatchingOrgan":"string","issuingState":"string","fathersFullName":"string","spouse":"string","documentSpouse":"string","cityBorn":"string","zipCode":"string","address":"string","numberAddress":"string","complementAddress":"string","neighborhood":"string","cityAddress":"string","country":"string","companyName":"string","occupationArea":"string","profession":"string","informedProfession":"string","monthlyIncome":42.0,"equityValue":"string","countryOfBirth":"string","stateBorn":"string","status":42.0,"stateAddress":"string","withoutDiscretionaryManagement":true,"gender":"string","ibgeCode":"string","mailingAddressIbgeCode":"string"}'
Request example 
{
  "nickName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "maritalString": "string",
  "mothersFullName": "string",
  "birthDate": "string",
  "mailingAddress": "string",
  "mailingAddressCountry": "string",
  "mailingAddressZipCode": "string",
  "mailingAddressStreet": "string",
  "mailingAddressNumber": "string",
  "mailingAddressComplement": "string",
  "mailingAddressNeighborhood": "string",
  "mailingAddressCity": "string",
  "mailingAddressState": "string",
  "currentlyWorking": "string",
  "busyAttorneyAccount": "string",
  "includeCarrierAccount": "string",
  "residentialOtherCountry": "string",
  "linkedPI": "string",
  "politicallyExposed": "string",
  "usPerson": "string",
  "hasAssets": "string",
  "otherEquity": 42.0,
  "equityInvestments": 42.0,
  "realEstate": 42.0,
  "automobileHeritage": "string",
  "doc_type": "string",
  "document": "string",
  "nationality": "string",
  "phone": "string",
  "telephone": "string",
  "rg": "string",
  "dateOfIssue": "string",
  "dispatchingOrgan": "string",
  "issuingState": "string",
  "fathersFullName": "string",
  "spouse": "string",
  "documentSpouse": "string",
  "cityBorn": "string",
  "zipCode": "string",
  "address": "string",
  "numberAddress": "string",
  "complementAddress": "string",
  "neighborhood": "string",
  "cityAddress": "string",
  "country": "string",
  "companyName": "string",
  "occupationArea": "string",
  "profession": "string",
  "informedProfession": "string",
  "monthlyIncome": 42.0,
  "equityValue": "string",
  "countryOfBirth": "string",
  "stateBorn": "string",
  "status": 42.0,
  "stateAddress": "string",
  "withoutDiscretionaryManagement": true,
  "gender": "string",
  "ibgeCode": "string",
  "mailingAddressIbgeCode": "string"
}
Request examples 
{
  "nickName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "maritalString": "string",
  "mothersFullName": "string",
  "birthDate": "string",
  "mailingAddress": "string",
  "mailingAddressCountry": "string",
  "mailingAddressZipCode": "string",
  "mailingAddressStreet": "string",
  "mailingAddressNumber": "string",
  "mailingAddressComplement": "string",
  "mailingAddressNeighborhood": "string",
  "mailingAddressCity": "string",
  "mailingAddressState": "string",
  "currentlyWorking": "string",
  "busyAttorneyAccount": "string",
  "includeCarrierAccount": "string",
  "residentialOtherCountry": "string",
  "linkedPI": "string",
  "politicallyExposed": "string",
  "usPerson": "string",
  "hasAssets": "string",
  "otherEquity": 42.0,
  "equityInvestments": 42.0,
  "realEstate": 42.0,
  "automobileHeritage": "string",
  "doc_type": "string",
  "document": "string",
  "nationality": "string",
  "phone": "string",
  "telephone": "string",
  "rg": "string",
  "dateOfIssue": "string",
  "dispatchingOrgan": "string",
  "issuingState": "string",
  "fathersFullName": "string",
  "spouse": "string",
  "documentSpouse": "string",
  "cityBorn": "string",
  "zipCode": "string",
  "address": "string",
  "numberAddress": "string",
  "complementAddress": "string",
  "neighborhood": "string",
  "cityAddress": "string",
  "country": "string",
  "companyName": "string",
  "occupationArea": "string",
  "profession": "string",
  "informedProfession": "string",
  "monthlyIncome": 42.0,
  "equityValue": "string",
  "countryOfBirth": "string",
  "stateBorn": "string",
  "status": 42.0,
  "stateAddress": "string",
  "withoutDiscretionaryManagement": true,
  "gender": "string",
  "ibgeCode": "string",
  "mailingAddressIbgeCode": "string"
}
Response examples (200) 
{
  "createCustomer": [
    {
      "id": "string",
      "zipCode": "string",
      "gender": "string",
      "document": "string",
      "companyName": "string",
      "stateAddress": "string",
      "mothersFullName": "string",
      "hasAssets": "string",
      "automobileHeritage": "string",
      "realEstate": "string",
      "equityInvestments": "string",
      "otherEquity": "string",
      "equityValue": "string",
      "occupationArea": "string",
      "countryOfBirth": "string",
      "stateBorn": "string",
      "currentlyWorking": "string",
      "cityAddress": "string",
      "informedProfession": "string",
      "email": "string",
      "monthlyIncome": "string",
      "profession": "string",
      "address": "string",
      "maritalString": "string",
      "firstName": "string",
      "lastName": "string",
      "cityBorn": "string",
      "birthDate": "string",
      "nationality": "string",
      "phone": "string",
      "mailingAddress": "string",
      "PEP": "string",
      "numberAddress": "string",
      "neighborhood": "string",
      "status": "string",
      "fees": [
        {
          "discount": 42.0,
          "type": "string",
          "paymentDay": 42.0,
          "begin": "string"
        }
      ]
    }
  ]
}
Response examples (200) 
{
  "createCustomer": [
    {
      "id": "string",
      "zipCode": "string",
      "gender": "string",
      "document": "string",
      "companyName": "string",
      "stateAddress": "string",
      "mothersFullName": "string",
      "hasAssets": "string",
      "automobileHeritage": "string",
      "realEstate": "string",
      "equityInvestments": "string",
      "otherEquity": "string",
      "equityValue": "string",
      "occupationArea": "string",
      "countryOfBirth": "string",
      "stateBorn": "string",
      "currentlyWorking": "string",
      "cityAddress": "string",
      "informedProfession": "string",
      "email": "string",
      "monthlyIncome": "string",
      "profession": "string",
      "address": "string",
      "maritalString": "string",
      "firstName": "string",
      "lastName": "string",
      "cityBorn": "string",
      "birthDate": "string",
      "nationality": "string",
      "phone": "string",
      "mailingAddress": "string",
      "PEP": "string",
      "numberAddress": "string",
      "neighborhood": "string",
      "status": "string",
      "fees": [
        {
          "discount": 42.0,
          "type": "string",
          "paymentDay": 42.0,
          "begin": "string"
        }
      ]
    }
  ]
}
Response examples (401) 
{
  "message": {},
  "data": {}
}
Response examples (401) 
{
  "message": {},
  "data": {}
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (422) 
{
  "message": {},
  "data": {}
}
Response examples (422) 
{
  "message": {},
  "data": {}
}