{"components":{"schemas":{"BadRequest":{"description":"Returned when something is wrong in the request, e.g. failed argument validation or missed argument","properties":{"attributes":{"description":"Invalid attributes","items":{"$ref":"#/components/schemas/RequestAttribute"},"type":"array"},"error":{"default":"BadRequest","description":"Error name","type":"string"},"message":{"default":"Required arguments are missing in the request","description":"Description of the request error","type":"string"}},"type":"object"},"Birth":{"properties":{"birthCongregation":{"type":"string"},"birthCountyCode":{"type":"string"},"birthDate":{"type":"string"}},"type":"object"},"ContactAddress":{"properties":{"dateFrom":{"description":"Date from when the information is valid","type":"string"},"dateTo":{"description":"Date up until when the information is valid. Date 9999-12-31 means that the record is valid","type":"string"},"internationalAddress":{"$ref":"#/components/schemas/InternationalAddress"},"swedishAddress":{"$ref":"#/components/schemas/SwedishAddress"}},"type":"object"},"CoordinationNumberInformation":{"properties":{"attributionDate":{"description":"Date when the coordination number was attributed to a person. Can be an incomplete date","type":"string"},"deathDate":{"description":"Date of death. Only used when inactivation reason is “deceased”. Can be an incomplete date","type":"string"},"expectedInactivationDate":{"description":"Date when the coordination number is expected to be inactivated. Can be an incomplete date","type":"string"},"inactivationDate":{"description":"Date of inactivation of the coordination number","type":"string"},"inactivationReason":{"description":"Reason for inactivation of the coordination number","type":"string"},"renewalDate":{"description":"Date when the coordination number was renewed. Can be an incomplete date","type":"string"},"status":{"description":"Can show information about closure, if the coordination number is declared inactive. This indicates that there might be a reference to a new number","type":"string"}},"type":"object"},"Death":{"properties":{"deathDate":{"type":"string"},"foundDeadDate":{"type":"string"}},"type":"object"},"ForeignAddress":{"properties":{"dateFrom":{"type":"string"},"dateTo":{"type":"string"},"internationalAddress":{"$ref":"#/components/schemas/InternationalAddress"}},"type":"object"},"InternationalAddress":{"properties":{"country":{"description":"Name of the country","type":"string"},"deliveryAddress1":{"description":"Physical address, for example information about street","type":"string"},"deliveryAddress2":{"description":"Physical address, for example information about street","type":"string"},"deliveryAddress3":{"description":"Physical address, for example information about street","type":"string"}},"type":"object"},"Person":{"properties":{"aggregatedIncome":{"description":"Aggregated income from work and capital, earned in the incomeYear","type":"string"},"contactAddress":{"items":{"$ref":"#/components/schemas/ContactAddress"},"type":"array"},"details":{"items":{"$ref":"#/components/schemas/PersonDetails"},"type":"array"},"foreignAddress":{"items":{"$ref":"#/components/schemas/ForeignAddress"},"type":"array"},"incomeYear":{"description":"The year when the aggregated income was earned","type":"string"},"name":{"items":{"$ref":"#/components/schemas/PersonName"},"type":"array"},"nationalRegistryChangeDate":{"description":"Date for latest change in the Swedish state personal address register","type":"string"},"personId":{"description":"The unique identifier of a person in the Swedish state personal address register","type":"string"},"personIdType":{"description":"The type of the identifier, could be code for either personal number or coordination number","type":"string"},"populationRegistration":{"items":{"$ref":"#/components/schemas/PopulationRegistration"},"type":"array"},"populationRegistrationAddress":{"items":{"$ref":"#/components/schemas/PopulationRegistrationAddress"},"type":"array"},"protectedRegistration":{"description":"Protected in the National Register. The consumer's information is protected and will not be returned. Any previously stored information should be removed in compliance with local laws","type":"boolean"},"protectedRegistrationDate":{"description":"Date when the person was protected in the register","type":"string"},"realEstate":{"items":{"$ref":"#/components/schemas/RealEstate"},"type":"array"},"relation":{"items":{"$ref":"#/components/schemas/Relation"},"type":"array"},"secrecy":{"$ref":"#/components/schemas/Secrecy"},"secrecyDate":{"description":"Date when the person was marked with secrecy","type":"string"},"specialPostalAddress":{"items":{"$ref":"#/components/schemas/SpecialPostalAddress"},"type":"array"}},"type":"object"},"PersonDetails":{"properties":{"birth":{"$ref":"#/components/schemas/Birth"},"coordinationNumberInformation":{"$ref":"#/components/schemas/CoordinationNumberInformation"},"dateFrom":{"description":"Date from which the information is or was valid","type":"string"},"dateTo":{"description":"Date up until when the information is or was valid. Date 9999-12-31 means that the record is valid","type":"string"},"deRegistrationDate":{"type":"string"},"deRegistrationReasonCode":{"type":"string"},"death":{"$ref":"#/components/schemas/Death"},"gender":{"enum":["MALE","FEMALE"],"type":"string"},"personIdChangeInformation":{"items":{"$ref":"#/components/schemas/PersonIdChangeInformation"},"type":"array"},"protectedRegistration":{"type":"boolean"},"secrecy":{"$ref":"#/components/schemas/Secrecy"},"swedishCitizen":{"type":"boolean"}},"type":"object"},"PersonIdChangeInformation":{"properties":{"referencePersonId":{"type":"string"},"referenceType":{"enum":["FROM","TO"],"type":"string"}},"type":"object"},"PersonName":{"properties":{"dateFrom":{"description":"Date from when the information is valid","type":"string"},"dateTo":{"description":"Date up until when the information is or was valid. Date 9999-12-31 means that the record is valid.","type":"string"},"firstName":{"description":"All first names, divided by space","type":"string"},"givenNameCode":{"description":"Code which points out which of the first names is the name the person goes by. Not available for all persons.","format":"int32","type":"integer"},"middleName":{"description":"Name between first and last name. Often the persons last name before marriage","type":"string"},"shortenedName":{"description":"Middle name, surname and first name together, in that order","type":"string"},"surName":{"description":"Surname","type":"string"}},"type":"object"},"PersonResults":{"description":"Roaring Group Person information results","properties":{"records":{"description":"found person information results","items":{"$ref":"#/components/schemas/Person"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"PopulationRegistration":{"properties":{"countyCode":{"description":"County code","type":"string"},"dateFrom":{"description":"Date from when the information is valid","type":"string"},"dateTo":{"description":"Date up until when the information is valid. Date 9999-12-31 means that the record is valid","type":"string"},"districtCode":{"description":"For persons registered at a property which has  a district code. This information is only available after 1st Jan 2016","type":"string"},"municipalityCode":{"description":"Municipality code","type":"string"},"populationRegistrationDate":{"description":"Date of population registration","type":"string"},"residenceStatusCode":{"description":"The code holds information about special cases of registration/residence, see reference table","enum":["RESIDENTIAL","MUNICIPAL","UNKNOWN"],"type":"string"}},"type":"object"},"PopulationRegistrationAddress":{"properties":{"dateFrom":{"type":"string"},"dateTo":{"type":"string"},"swedishAddress":{"$ref":"#/components/schemas/SwedishAddress"}},"type":"object"},"RealEstate":{"properties":{"countyCode":{"description":"County code where the real estate is situated","type":"string"},"municipalityCode":{"description":"Municipality code where the real estate is situated","type":"string"},"realEstatePart":{"items":{"$ref":"#/components/schemas/RealEstatePart"},"type":"array"},"realEstateTypeCode":{"description":"Code for type of real estate","type":"string"},"taxationUnitIdentificationNumber":{"type":"string"},"taxationValue":{"description":"Taxable value in Swedish SEK (Sum of buildings and land)","type":"string"},"taxationYear":{"description":"Year when the real estate unit was latest taxed","type":"string"}},"type":"object"},"RealEstatePart":{"properties":{"identification":{"description":"Identity for the part of the real estate","type":"string"},"name":{"description":"Name of the part of the real estate","type":"string"},"shareDenominator":{"description":"Owner share in the part of the real estate - denominator part of share","type":"integer"},"shareNumerator":{"description":"Owner share in the part of the real estate - numerator part of share","type":"integer"}},"type":"object"},"Relation":{"properties":{"birthDate":{"description":"Birth date of a related person who does not have an identification number","type":"string"},"dateFrom":{"description":"Date from when the information is valid","type":"string"},"dateTo":{"description":"Date up until when the information is valid. Date 9999-12-31 means that the record is valid","type":"string"},"deRegistrationDate":{"description":"Date when the person was deregistered from national register because deceased. Can be an incomplete date","type":"string"},"deRegistrationReasonCode":{"description":"Reason for deregistration in population register","type":"string"},"deathDate":{"description":"Date when the person was deregistered from national register because deceased. Can be an incomplete date","type":"string"},"firstName":{"description":"First name of a related person who does not have an identification number","type":"string"},"middleName":{"description":"Middle name of a related person who does not have an identification number","type":"string"},"personId":{"description":"Identification, can be a personal number, cooperation number or an immunity number","type":"string"},"relationType":{"description":"Shows how the related person is related","enum":["GUARDIAN","SPOUSE_OR_PARTNER"],"type":"string"},"surName":{"type":"string"}},"type":"object"},"RequestAttribute":{"description":"Incorrect attribute of request","properties":{"attribute":{"description":"Parameter name","type":"string"},"value":{"description":"Parameter value, subject for validation","type":"string"}},"type":"object"},"SearchResultStatus":{"description":"Description of search result","properties":{"code":{"description":"0 - found, 1 - not found","format":"int32","type":"integer"},"responseMode":{"description":"1 - direct provider, 2 - intermediary provider","format":"int32","type":"integer"},"text":{"description":"search result description","type":"string"}},"type":"object"},"Secrecy":{"properties":{"secrecy":{"description":"Secrecy marking. The consumer's information is protected and will not be returned. Any previously stored information should be removed in compliance with local laws","type":"boolean"},"secrecySetBySpar":{"description":"Shows whether SPAR has set the secrecy because the National register has marked the person as protected in register","type":"boolean"}},"type":"object"},"ServerError":{"description":"Internal server error","properties":{"error":{"default":"InternalServerError","description":"Error name","type":"string"},"message":{"default":"An internal server error occurred, please contact the system administrator with information on the error","description":"Description of the request error","type":"string"}},"type":"object"},"SpecialPostalAddress":{"properties":{"dateFrom":{"description":"Date from when the information is valid","type":"string"},"dateTo":{"description":"Date up until when the information is  valid. Date 9999-12-31 means that the record is valid","type":"string"},"internationalAddress":{"$ref":"#/components/schemas/InternationalAddress"},"swedishAddress":{"$ref":"#/components/schemas/SwedishAddress"}},"type":"object"},"SwedishAddress":{"properties":{"city":{"description":"Postal town","type":"string"},"coAddress":{"type":"string"},"deliveryAddress1":{"description":"Physical address, for example information about street. deliveryAddress2 is normally the first choice, where deliveryAddress1 is used if the address is long","type":"string"},"deliveryAddress2":{"description":"Physical address, for example information about street. deliveryAddress2 is normally the first choice, where deliveryAddress1 is used if the address is long","type":"string"},"zipCode":{"description":"Zip code","type":"string"}},"type":"object"}},"securitySchemes":{"OAuth2":{"description":"All requests require authentication via OAuth2 client credentials.\n\nBase URL: https://api.roaring.io\n\n1. Obtain a Consumer key and Consumer secret from https://developer.roaring.io/keys\n   (separate sandbox and production pairs).\n2. Request an access token by POSTing to the token endpoint:\n\n   POST https://api.roaring.io/token\n   Content-Type: application/x-www-form-urlencoded\n   Authorization: Basic base64(consumer-key:consumer-secret)\n\n   body: grant_type=client_credentials\n\n   Tokens are valid for 3600 seconds. The response contains an access_token of\n   type Bearer.\n3. Send the access token on every API call:\n\n   Authorization: Bearer <access_token>","flows":{"clientCredentials":{"tokenUrl":"https://api.roaring.io/token","scopes":{}}},"type":"oauth2"}}},"info":{"title":"Person information","version":"2.0","x-logo":{"url":"https://assets.roaring.io/svg/person-v3.1.svg"},"description":"All requests require authentication via OAuth2 client credentials.\n\nBase URL: https://api.roaring.io\n\n1. Obtain a Consumer key and Consumer secret from https://developer.roaring.io/keys\n   (separate sandbox and production pairs).\n2. Request an access token by POSTing to the token endpoint:\n\n   POST https://api.roaring.io/token\n   Content-Type: application/x-www-form-urlencoded\n   Authorization: Basic base64(consumer-key:consumer-secret)\n\n   body: grant_type=client_credentials\n\n   Tokens are valid for 3600 seconds. The response contains an access_token of\n   type Bearer.\n3. Send the access token on every API call:\n\n   Authorization: Bearer <access_token>"},"openapi":"3.0.1","paths":{"/current/{personId}":{"get":{"operationId":"getCurrent","parameters":[{"description":"person id","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonResults"}}},"description":"OK, successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"Returned when something is wrong in the request, e.g. failed argument validation or arguments are missing"},"404":{"description":"Requested resource could not be found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"An internal server error occurred, please contact the system administrator with information on the error"}},"summary":"Find person by personId","tags":["PersonAPI"]}},"/full/{personId}":{"get":{"operationId":"getFull","parameters":[{"description":"person id","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonResults"}}},"description":"OK, successful response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}},"description":"Returned when something is wrong in the request, e.g. failed argument validation or arguments are missing"},"404":{"description":"Requested resource could not be found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"An internal server error occurred, please contact the system administrator with information on the error"}},"summary":"Find person by personId","tags":["PersonAPI"]}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://api.roaring.io/person/2.0"}],"x-category":"person","x-countries":["se"],"x-id":"PersonAPI"}