Get Customer By Id

GET /customers/{id}

Path parameters

  • id string(uuid) Required

Responses

  • 200
    Hide response attribute Show response attribute object
    • customer object Required
      Hide customer attributes Show customer attributes object
      • zipCode string Required
      • gender string Required
      • document string Required
      • typePerson string Required
      • companyName string Required
      • stateAddress string Required
      • mothersFullName string Required
      • PLDistributionPercentage string Required
      • hasAssets string Required
      • automobileHeritage number Required
      • realEstate number Required
      • equityInvestments number Required
      • otherEquity number Required
      • equityValue number Required
      • occupationArea string Required
      • countryOfBirth string Required
      • stateBorn string Required
      • currentlyWorking string Required
      • cityAddress string Required
      • informedProfession string Required
      • id string Required
      • email string Required
      • monthlyIncome number Required
      • profession string Required
      • address string Required
      • maritalString string Required
      • dispatchingOrgan string Required
      • firstName string Required
      • lastName string Required
      • nickName string Required
      • cityBorn string Required
      • issuingState string Required
      • dateOfIssue string Required
      • birthDate string Required
      • nationality string Required
      • phone string Required
      • rg string Required
      • mailingAddress string Required
      • PEP string Required
      • numberAddress string Required
      • neighborhood string Required
      • status number Required
      • cuc string Required
      • investorProfileLevel string Required
      • isQualifiedInvestor string Required
      • created 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
GET /customers/{id}
curl \
 -X GET https://open-api.hml.soupi.com.br/customers/{id} \
 -H "Authorization: $API_KEY"
Response examples (200)
{
  "customer": {
    "zipCode": "string",
    "gender": "string",
    "document": "string",
    "typePerson": "string",
    "companyName": "string",
    "stateAddress": "string",
    "mothersFullName": "string",
    "PLDistributionPercentage": "string",
    "hasAssets": "string",
    "automobileHeritage": 42.0,
    "realEstate": 42.0,
    "equityInvestments": 42.0,
    "otherEquity": 42.0,
    "equityValue": 42.0,
    "occupationArea": "string",
    "countryOfBirth": "string",
    "stateBorn": "string",
    "currentlyWorking": "string",
    "cityAddress": "string",
    "informedProfession": "string",
    "id": "string",
    "email": "string",
    "monthlyIncome": 42.0,
    "profession": "string",
    "address": "string",
    "maritalString": "string",
    "dispatchingOrgan": "string",
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "cityBorn": "string",
    "issuingState": "string",
    "dateOfIssue": "string",
    "birthDate": "string",
    "nationality": "string",
    "phone": "string",
    "rg": "string",
    "mailingAddress": "string",
    "PEP": "string",
    "numberAddress": "string",
    "neighborhood": "string",
    "status": 42.0,
    "cuc": "string",
    "investorProfileLevel": "string",
    "isQualifiedInvestor": "string",
    "created": "string"
  }
}
Response examples (200)
{
  "customer": {
    "zipCode": "string",
    "gender": "string",
    "document": "string",
    "typePerson": "string",
    "companyName": "string",
    "stateAddress": "string",
    "mothersFullName": "string",
    "PLDistributionPercentage": "string",
    "hasAssets": "string",
    "automobileHeritage": 42.0,
    "realEstate": 42.0,
    "equityInvestments": 42.0,
    "otherEquity": 42.0,
    "equityValue": 42.0,
    "occupationArea": "string",
    "countryOfBirth": "string",
    "stateBorn": "string",
    "currentlyWorking": "string",
    "cityAddress": "string",
    "informedProfession": "string",
    "id": "string",
    "email": "string",
    "monthlyIncome": 42.0,
    "profession": "string",
    "address": "string",
    "maritalString": "string",
    "dispatchingOrgan": "string",
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "cityBorn": "string",
    "issuingState": "string",
    "dateOfIssue": "string",
    "birthDate": "string",
    "nationality": "string",
    "phone": "string",
    "rg": "string",
    "mailingAddress": "string",
    "PEP": "string",
    "numberAddress": "string",
    "neighborhood": "string",
    "status": 42.0,
    "cuc": "string",
    "investorProfileLevel": "string",
    "isQualifiedInvestor": "string",
    "created": "string"
  }
}
Response examples (401)
{
  "message": {},
  "data": {}
}
Response examples (401)
{
  "message": {},
  "data": {}
}
Response examples (400)
{
  "message": {},
  "data": {}
}
Response examples (400)
{
  "message": {},
  "data": {}
}