NAV Navbar

Customer API v1.0

Scroll down for example requests and responses.

person-api-controller

Person Api Controller

searchUsingGET

Code samples

GET /api/v1/persons

search

Parameters

Parameter In Type Required Description
email query string false email
name query string false name
idNumber query string false idNumber
statusCode query string false statusCode

Example responses

200 Response

{
  "data": [
    {
      "housingTypeCode": "housingTypeCode",
      "incomes": [
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        },
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        }
      ],
      "address": {
        "zip": "zip",
        "addressTypeCode": "addressTypeCode",
        "countryCode": "countryCode",
        "stateRegion": "stateRegion",
        "personId": 6,
        "street1": "street1",
        "street2": "street2",
        "addressId": 0,
        "cityCounty": "cityCounty"
      },
      "givenName": "givenName",
      "sex": "sex",
      "obligations": [
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        },
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        }
      ],
      "idCountryCode": "idCountryCode",
      "educationCode": "educationCode",
      "idNumber": "idNumber",
      "birthDate": "2000-01-23",
      "activityCode": "activityCode",
      "maritalStatusCode": "maritalStatusCode",
      "buildingTypeCode": "buildingTypeCode",
      "phoneNumber": "phoneNumber",
      "moveInDate": "2000-01-23",
      "surname": "surname",
      "name": "name",
      "personId": 7,
      "dependentPersons": 1,
      "email": "email",
      "legalStatusCode": "legalStatusCode",
      "statusCode": "statusCode"
    },
    {
      "housingTypeCode": "housingTypeCode",
      "incomes": [
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        },
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        }
      ],
      "address": {
        "zip": "zip",
        "addressTypeCode": "addressTypeCode",
        "countryCode": "countryCode",
        "stateRegion": "stateRegion",
        "personId": 6,
        "street1": "street1",
        "street2": "street2",
        "addressId": 0,
        "cityCounty": "cityCounty"
      },
      "givenName": "givenName",
      "sex": "sex",
      "obligations": [
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        },
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        }
      ],
      "idCountryCode": "idCountryCode",
      "educationCode": "educationCode",
      "idNumber": "idNumber",
      "birthDate": "2000-01-23",
      "activityCode": "activityCode",
      "maritalStatusCode": "maritalStatusCode",
      "buildingTypeCode": "buildingTypeCode",
      "phoneNumber": "phoneNumber",
      "moveInDate": "2000-01-23",
      "surname": "surname",
      "name": "name",
      "personId": 7,
      "dependentPersons": 1,
      "email": "email",
      "legalStatusCode": "legalStatusCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_PersonJson_

createPersonUsingPOST

Code samples

POST /api/v1/persons

createPerson

Body parameter

{
  "housingTypeCode": "housingTypeCode",
  "income": {
    "amount": 6.027456183070403,
    "confirmedAmount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "address": {
    "zip": "zip",
    "countryCode": "countryCode",
    "stateRegion": "stateRegion",
    "street1": "street1",
    "street2": "street2",
    "cityCounty": "cityCounty"
  },
  "sex": "sex",
  "personTypeCode": "personTypeCode",
  "educationCode": "educationCode",
  "birthDate": "2000-01-23",
  "activityCode": "activityCode",
  "maritalStatusCode": "maritalStatusCode",
  "buildingTypeCode": "buildingTypeCode",
  "phoneNumber": "phoneNumber",
  "moveInDate": "2000-01-23",
  "obligation": {
    "remainingAmount": 5.637376656633329,
    "obligationTypeCode": "obligationTypeCode",
    "monthlyAmount": 5.962133916683182,
    "currencyCode": "currencyCode"
  },
  "name": "name",
  "identificationNumber": {
    "idCountryCode": "idCountryCode",
    "idNumber": "idNumber"
  },
  "email": "email",
  "dependantPersons": 0
}

Parameters

Parameter In Type Required Description
body body CreatePersonJson true json

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

findPersonUsingGET

Code samples

GET /api/v1/persons/{personId}

findPerson

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

activatePersonUsingPOST

Code samples

POST /api/v1/persons/{personId}/activate

activatePerson

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

findPersonAddressUsingGET

Code samples

GET /api/v1/persons/{personId}/address

findPersonAddress

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": {
    "zip": "zip",
    "addressTypeCode": "addressTypeCode",
    "countryCode": "countryCode",
    "stateRegion": "stateRegion",
    "personId": 6,
    "street1": "street1",
    "street2": "street2",
    "addressId": 0,
    "cityCounty": "cityCounty"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AddressJson_

updateAddressUsingPOST

Code samples

POST /api/v1/persons/{personId}/address

updateAddress

Body parameter

{
  "zip": "zip",
  "countryCode": "countryCode",
  "stateRegion": "stateRegion",
  "street1": "street1",
  "street2": "street2",
  "cityCounty": "cityCounty"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body CreateAddressJson true json

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

updateContactsUsingPOST

Code samples

POST /api/v1/persons/{personId}/contacts

updateContacts

Body parameter

{
  "phoneNumber": "phoneNumber",
  "email": "email"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body UpdateContactsJson true json

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

findPersonIdNumberUsingGET

Code samples

GET /api/v1/persons/{personId}/idnumber

findPersonIdNumber

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": {
    "idCountryCode": "idCountryCode",
    "personId": 6,
    "idNumberId": 0,
    "idNumber": "idNumber"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_IdNumberJson_

findPersonIncomesUsingGET

Code samples

GET /api/v1/persons/{personId}/incomes

findPersonIncomes

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": [
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    },
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_IncomeJson_

createPersonIncomesUsingPOST

Code samples

POST /api/v1/persons/{personId}/incomes

createPersonIncomes

Body parameter

{
  "amount": 6.027456183070403,
  "confirmedAmount": 1.4658129805029452,
  "currencyCode": "currencyCode"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body CreateIncomeJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findPersonLogsUsingGET

Code samples

GET /api/v1/persons/{personId}/logs

findPersonLogs

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": [
    {
      "creator": "creator",
      "logDate": "2000-01-23",
      "logTypeCode": "logTypeCode",
      "logId": 0,
      "personId": 6,
      "content": "content"
    },
    {
      "creator": "creator",
      "logDate": "2000-01-23",
      "logTypeCode": "logTypeCode",
      "logId": 0,
      "personId": 6,
      "content": "content"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_PersonLogJson_

createPersonLogUsingPOST

Code samples

POST /api/v1/persons/{personId}/logs

createPersonLog

Body parameter

{
  "creator": "creator",
  "logDate": "2000-01-23",
  "logTypeCode": "logTypeCode",
  "content": "content"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body CreatePersonLogJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findPersonObligationsUsingGET

Code samples

GET /api/v1/persons/{personId}/obligations

findPersonObligations

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId

Example responses

200 Response

{
  "data": [
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    },
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_ObligationJson_

createPersonObligationsUsingPOST

Code samples

POST /api/v1/persons/{personId}/obligations

createPersonObligations

Body parameter

{
  "remainingAmount": 5.637376656633329,
  "obligationTypeCode": "obligationTypeCode",
  "monthlyAmount": 5.962133916683182,
  "currencyCode": "currencyCode"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body CreateObligationJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

updatePersonalInfoUsingPOST

Code samples

POST /api/v1/persons/{personId}/personalInfo

updatePersonalInfo

Body parameter

{
  "maritalStatusCode": "maritalStatusCode",
  "sex": "sex",
  "identificationNumber": {
    "idCountryCode": "idCountryCode",
    "idNumber": "idNumber"
  }
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true personId
body body UpdatePersonalInfoJson true json

Example responses

200 Response

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PersonJson_

Schemas

AddressJson

{
  "zip": "zip",
  "addressTypeCode": "addressTypeCode",
  "countryCode": "countryCode",
  "stateRegion": "stateRegion",
  "personId": 6,
  "street1": "street1",
  "street2": "street2",
  "addressId": 0,
  "cityCounty": "cityCounty"
}

Properties

Name Type Required Restrictions Description
addressId integer(int64) false none none
addressTypeCode string false none none
cityCounty string false none none
countryCode string false none none
personId integer(int64) false none none
stateRegion string false none none
street1 string false none none
street2 string false none none
zip string false none none

CreateAddressJson

{
  "zip": "zip",
  "countryCode": "countryCode",
  "stateRegion": "stateRegion",
  "street1": "street1",
  "street2": "street2",
  "cityCounty": "cityCounty"
}

Properties

Name Type Required Restrictions Description
cityCounty string false none none
countryCode string false none none
stateRegion string false none none
street1 string false none none
street2 string false none none
zip string false none none

CreateIdentificationNumberJson

{
  "idCountryCode": "idCountryCode",
  "idNumber": "idNumber"
}

Properties

Name Type Required Restrictions Description
idCountryCode string false none none
idNumber string false none none

CreateIncomeJson

{
  "amount": 6.027456183070403,
  "confirmedAmount": 1.4658129805029452,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
amount number false none none
confirmedAmount number false none none
currencyCode string false none none

CreateObligationJson

{
  "remainingAmount": 5.637376656633329,
  "obligationTypeCode": "obligationTypeCode",
  "monthlyAmount": 5.962133916683182,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
monthlyAmount number false none none
obligationTypeCode string false none none
remainingAmount number false none none

CreatePersonJson

{
  "housingTypeCode": "housingTypeCode",
  "income": {
    "amount": 6.027456183070403,
    "confirmedAmount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "address": {
    "zip": "zip",
    "countryCode": "countryCode",
    "stateRegion": "stateRegion",
    "street1": "street1",
    "street2": "street2",
    "cityCounty": "cityCounty"
  },
  "sex": "sex",
  "personTypeCode": "personTypeCode",
  "educationCode": "educationCode",
  "birthDate": "2000-01-23",
  "activityCode": "activityCode",
  "maritalStatusCode": "maritalStatusCode",
  "buildingTypeCode": "buildingTypeCode",
  "phoneNumber": "phoneNumber",
  "moveInDate": "2000-01-23",
  "obligation": {
    "remainingAmount": 5.637376656633329,
    "obligationTypeCode": "obligationTypeCode",
    "monthlyAmount": 5.962133916683182,
    "currencyCode": "currencyCode"
  },
  "name": "name",
  "identificationNumber": {
    "idCountryCode": "idCountryCode",
    "idNumber": "idNumber"
  },
  "email": "email",
  "dependantPersons": 0
}

Properties

Name Type Required Restrictions Description
activityCode string false none none
address CreateAddressJson false none none
birthDate string(date) false none none
buildingTypeCode string false none none
dependantPersons integer(int32) false none none
educationCode string false none none
email string false none none
housingTypeCode string false none none
identificationNumber CreateIdentificationNumberJson false none none
income CreateIncomeJson false none none
maritalStatusCode string false none none
moveInDate string(date) false none none
name string false none none
obligation CreateObligationJson false none none
personTypeCode string false none none
phoneNumber string false none none
sex string false none none

CreatePersonLogJson

{
  "creator": "creator",
  "logDate": "2000-01-23",
  "logTypeCode": "logTypeCode",
  "content": "content"
}

Properties

Name Type Required Restrictions Description
content string false none none
creator string false none none
logDate string(date) false none none
logTypeCode string false none none

IdNumberJson

{
  "idCountryCode": "idCountryCode",
  "personId": 6,
  "idNumberId": 0,
  "idNumber": "idNumber"
}

Properties

Name Type Required Restrictions Description
idCountryCode string false none none
idNumber string false none none
idNumberId integer(int64) false none none
personId integer(int64) false none none

IncomeJson

{
  "amount": 5.962133916683182,
  "incomeId": 2,
  "confirmedAmount": 5.637376656633329,
  "registrationDate": "2000-01-23",
  "personId": 7,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
amount number false none none
confirmedAmount number false none none
currencyCode string false none none
incomeId integer(int64) false none none
personId integer(int64) false none none
registrationDate string(date) false none none

ObligationJson

{
  "remainingAmount": 4.145608029883936,
  "obligationTypeCode": "obligationTypeCode",
  "registrationDate": "2000-01-23",
  "obligationId": 3,
  "personId": 2,
  "monthlyAmount": 9.301444243932576,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
monthlyAmount number false none none
obligationId integer(int64) false none none
obligationTypeCode string false none none
personId integer(int64) false none none
registrationDate string(date) false none none
remainingAmount number false none none

PersonJson

{
  "housingTypeCode": "housingTypeCode",
  "incomes": [
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    },
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    }
  ],
  "address": {
    "zip": "zip",
    "addressTypeCode": "addressTypeCode",
    "countryCode": "countryCode",
    "stateRegion": "stateRegion",
    "personId": 6,
    "street1": "street1",
    "street2": "street2",
    "addressId": 0,
    "cityCounty": "cityCounty"
  },
  "givenName": "givenName",
  "sex": "sex",
  "obligations": [
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    },
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    }
  ],
  "idCountryCode": "idCountryCode",
  "educationCode": "educationCode",
  "idNumber": "idNumber",
  "birthDate": "2000-01-23",
  "activityCode": "activityCode",
  "maritalStatusCode": "maritalStatusCode",
  "buildingTypeCode": "buildingTypeCode",
  "phoneNumber": "phoneNumber",
  "moveInDate": "2000-01-23",
  "surname": "surname",
  "name": "name",
  "personId": 7,
  "dependentPersons": 1,
  "email": "email",
  "legalStatusCode": "legalStatusCode",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
activityCode string false none none
address AddressJson false none none
birthDate string(date) false none none
buildingTypeCode string false none none
dependentPersons integer(int32) false none none
educationCode string false none none
email string false none none
givenName string false none none
housingTypeCode string false none none
idCountryCode string false none none
idNumber string false none none
incomes [IncomeJson] false none none
legalStatusCode string false none none
maritalStatusCode string false none none
moveInDate string(date) false none none
name string false none none
obligations [ObligationJson] false none none
personId integer(int64) false none none
phoneNumber string false none none
sex string false none none
statusCode string false none none
surname string false none none

PersonLogJson

{
  "creator": "creator",
  "logDate": "2000-01-23",
  "logTypeCode": "logTypeCode",
  "logId": 0,
  "personId": 6,
  "content": "content"
}

Properties

Name Type Required Restrictions Description
content string false none none
creator string false none none
logDate string(date) false none none
logId integer(int64) false none none
logTypeCode string false none none
personId integer(int64) false none none

UpdateContactsJson

{
  "phoneNumber": "phoneNumber",
  "email": "email"
}

Properties

Name Type Required Restrictions Description
email string false none none
phoneNumber string false none none

UpdatePersonalInfoJson

{
  "maritalStatusCode": "maritalStatusCode",
  "sex": "sex",
  "identificationNumber": {
    "idCountryCode": "idCountryCode",
    "idNumber": "idNumber"
  }
}

Properties

Name Type Required Restrictions Description
identificationNumber CreateIdentificationNumberJson false none none
maritalStatusCode string false none none
sex string false none none

ResponseJson_AddressJson_

{
  "data": {
    "zip": "zip",
    "addressTypeCode": "addressTypeCode",
    "countryCode": "countryCode",
    "stateRegion": "stateRegion",
    "personId": 6,
    "street1": "street1",
    "street2": "street2",
    "addressId": 0,
    "cityCounty": "cityCounty"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data AddressJson false none none
errors [string] false none none

ResponseJson_IdNumberJson_

{
  "data": {
    "idCountryCode": "idCountryCode",
    "personId": 6,
    "idNumberId": 0,
    "idNumber": "idNumber"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data IdNumberJson false none none
errors [string] false none none

ResponseJson_List_PersonLogJson_

{
  "data": [
    {
      "creator": "creator",
      "logDate": "2000-01-23",
      "logTypeCode": "logTypeCode",
      "logId": 0,
      "personId": 6,
      "content": "content"
    },
    {
      "creator": "creator",
      "logDate": "2000-01-23",
      "logTypeCode": "logTypeCode",
      "logId": 0,
      "personId": 6,
      "content": "content"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [PersonLogJson] false none none
errors [string] false none none

ResponseJson_PersonJson_

{
  "data": {
    "housingTypeCode": "housingTypeCode",
    "incomes": [
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      },
      {
        "amount": 5.962133916683182,
        "incomeId": 2,
        "confirmedAmount": 5.637376656633329,
        "registrationDate": "2000-01-23",
        "personId": 7,
        "currencyCode": "currencyCode"
      }
    ],
    "address": {
      "zip": "zip",
      "addressTypeCode": "addressTypeCode",
      "countryCode": "countryCode",
      "stateRegion": "stateRegion",
      "personId": 6,
      "street1": "street1",
      "street2": "street2",
      "addressId": 0,
      "cityCounty": "cityCounty"
    },
    "givenName": "givenName",
    "sex": "sex",
    "obligations": [
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      },
      {
        "remainingAmount": 4.145608029883936,
        "obligationTypeCode": "obligationTypeCode",
        "registrationDate": "2000-01-23",
        "obligationId": 3,
        "personId": 2,
        "monthlyAmount": 9.301444243932576,
        "currencyCode": "currencyCode"
      }
    ],
    "idCountryCode": "idCountryCode",
    "educationCode": "educationCode",
    "idNumber": "idNumber",
    "birthDate": "2000-01-23",
    "activityCode": "activityCode",
    "maritalStatusCode": "maritalStatusCode",
    "buildingTypeCode": "buildingTypeCode",
    "phoneNumber": "phoneNumber",
    "moveInDate": "2000-01-23",
    "surname": "surname",
    "name": "name",
    "personId": 7,
    "dependentPersons": 1,
    "email": "email",
    "legalStatusCode": "legalStatusCode",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data PersonJson false none none
errors [string] false none none

ResponseJson_Void_

{
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
errors [string] false none none

ResponseListJson_List_IncomeJson_

{
  "data": [
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    },
    {
      "amount": 5.962133916683182,
      "incomeId": 2,
      "confirmedAmount": 5.637376656633329,
      "registrationDate": "2000-01-23",
      "personId": 7,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [IncomeJson] false none none
errors [string] false none none

ResponseListJson_List_ObligationJson_

{
  "data": [
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    },
    {
      "remainingAmount": 4.145608029883936,
      "obligationTypeCode": "obligationTypeCode",
      "registrationDate": "2000-01-23",
      "obligationId": 3,
      "personId": 2,
      "monthlyAmount": 9.301444243932576,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [ObligationJson] false none none
errors [string] false none none

ResponseListJson_List_PersonJson_

{
  "data": [
    {
      "housingTypeCode": "housingTypeCode",
      "incomes": [
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        },
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        }
      ],
      "address": {
        "zip": "zip",
        "addressTypeCode": "addressTypeCode",
        "countryCode": "countryCode",
        "stateRegion": "stateRegion",
        "personId": 6,
        "street1": "street1",
        "street2": "street2",
        "addressId": 0,
        "cityCounty": "cityCounty"
      },
      "givenName": "givenName",
      "sex": "sex",
      "obligations": [
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        },
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        }
      ],
      "idCountryCode": "idCountryCode",
      "educationCode": "educationCode",
      "idNumber": "idNumber",
      "birthDate": "2000-01-23",
      "activityCode": "activityCode",
      "maritalStatusCode": "maritalStatusCode",
      "buildingTypeCode": "buildingTypeCode",
      "phoneNumber": "phoneNumber",
      "moveInDate": "2000-01-23",
      "surname": "surname",
      "name": "name",
      "personId": 7,
      "dependentPersons": 1,
      "email": "email",
      "legalStatusCode": "legalStatusCode",
      "statusCode": "statusCode"
    },
    {
      "housingTypeCode": "housingTypeCode",
      "incomes": [
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        },
        {
          "amount": 5.962133916683182,
          "incomeId": 2,
          "confirmedAmount": 5.637376656633329,
          "registrationDate": "2000-01-23",
          "personId": 7,
          "currencyCode": "currencyCode"
        }
      ],
      "address": {
        "zip": "zip",
        "addressTypeCode": "addressTypeCode",
        "countryCode": "countryCode",
        "stateRegion": "stateRegion",
        "personId": 6,
        "street1": "street1",
        "street2": "street2",
        "addressId": 0,
        "cityCounty": "cityCounty"
      },
      "givenName": "givenName",
      "sex": "sex",
      "obligations": [
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        },
        {
          "remainingAmount": 4.145608029883936,
          "obligationTypeCode": "obligationTypeCode",
          "registrationDate": "2000-01-23",
          "obligationId": 3,
          "personId": 2,
          "monthlyAmount": 9.301444243932576,
          "currencyCode": "currencyCode"
        }
      ],
      "idCountryCode": "idCountryCode",
      "educationCode": "educationCode",
      "idNumber": "idNumber",
      "birthDate": "2000-01-23",
      "activityCode": "activityCode",
      "maritalStatusCode": "maritalStatusCode",
      "buildingTypeCode": "buildingTypeCode",
      "phoneNumber": "phoneNumber",
      "moveInDate": "2000-01-23",
      "surname": "surname",
      "name": "name",
      "personId": 7,
      "dependentPersons": 1,
      "email": "email",
      "legalStatusCode": "legalStatusCode",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [PersonJson] false none none
errors [string] false none none