Path parameters

  • id string(uuid) Required

Responses

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 (400)
{
  "message": {},
  "data": {}
}
Response examples (400)
{
  "message": {},
  "data": {}
}
Response examples (401)
{
  "message": {},
  "data": {}
}
Response examples (401)
{
  "message": {},
  "data": {}
}