{"components":{"schemas":{"Address":{"properties":{"foreignAddress":{"allOf":[{"$ref":"#/components/schemas/ForeignAddress"}],"description":"Foreign address fields"},"nationalRegistrationAddress":{"allOf":[{"$ref":"#/components/schemas/NationalRegistrationAddress"}],"description":"National registration address fields"}},"type":"object"},"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"},"CurrentPerson":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/CurrentPersonAddress"}],"description":"Address fields"},"birthDate":{"description":"Birth date","type":"string"},"birthDateUncertain":{"description":"Whether the birth date is unclear","type":"boolean"},"currentPersonId":{"description":"New personal identification number if it was changed for some reason.","type":"string"},"gender":{"description":"Gender code","type":"string"},"guardianshipDate":{"description":"Date of guardianship","type":"string"},"marketingProtection":{"description":"Whether the person has chosen to be protected against marketing","type":"boolean"},"name":{"allOf":[{"$ref":"#/components/schemas/CurrentPersonName"}],"description":"Name fields"},"personId":{"description":"Danish civil registration number - CPR number","type":"string"},"personStatus":{"allOf":[{"$ref":"#/components/schemas/CurrentPersonStatus"}],"description":"Status fields"},"secrecyMarked":{"description":"Whether the person has protection regarding name and address","type":"boolean"}},"type":"object"},"CurrentPersonAddress":{"properties":{"nationalRegistrationAddress":{"allOf":[{"$ref":"#/components/schemas/CurrentPersonNationalRegistrationAddress"}],"description":"National registration address fields"}},"type":"object"},"CurrentPersonName":{"properties":{"firstName":{"description":"First name","type":"string"},"fullName":{"description":"Full name (both first and last name space separated)","type":"string"},"lastName":{"description":"Last name","type":"string"},"middleName":{"description":"Middle name","type":"string"}},"type":"object"},"CurrentPersonNationalRegistrationAddress":{"properties":{"address":{"description":"Full street address text line","type":"string"},"buildingNumber":{"description":"Building number, used on Greenland in place of house number","type":"string"},"coAddress":{"description":"c/o address","type":"string"},"doorPlacement":{"description":"Door placement","type":"string"},"floorNumber":{"description":"Floor number","type":"string"},"houseNumber":{"description":"House number","type":"string"},"locality":{"description":"Locality text, e.g. farm name","type":"string"},"municipalityCode":{"description":"Municipality code","type":"string"},"municipalityLong":{"description":"Municipality long text","type":"string"},"municipalityShort":{"description":"Municipality short text","type":"string"},"registrationDate":{"description":"Registration date for the address","type":"string"},"streetCode":{"description":"Street code","type":"string"},"streetText":{"description":"Street name","type":"string"},"streetTextForAddress":{"description":"An abbreviation of street name, which is used for shipments.","type":"string"},"town":{"description":"Postal town","type":"string"},"village":{"description":"Village text","type":"string"},"zipCode":{"description":"Zip code","type":"string"}},"type":"object"},"CurrentPersonResults":{"description":"Roaring Group person current information results","properties":{"records":{"description":"found person current information results","items":{"$ref":"#/components/schemas/CurrentPerson"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"CurrentPersonStatus":{"properties":{"code":{"description":"Person status code, shows for example if person is dead or has emigrated etc.","type":"string"},"fromDate":{"description":"Date from when status was set","type":"string"},"statusDateUncertain":{"description":"Whether the status date is uncertain","type":"boolean"},"text":{"description":"Descriptive text for status code","type":"string"}},"type":"object"},"Forbidden":{"description":"Returned when request is not authorized due to insufficient credentials","properties":{"error":{"default":"Forbidden","description":"Error name","type":"string"},"message":{"default":"Request is not authorized due to insufficient credentials","description":"Description of the request error","type":"string"}},"type":"object"},"ForeignAddress":{"properties":{"addressLine1":{"description":"Address lines for foreign addresses","type":"string"},"addressLine2":{"description":"Address lines for foreign addresses","type":"string"},"addressLine3":{"description":"Address lines for foreign addresses","type":"string"},"addressLine4":{"description":"Address lines for foreign addresses","type":"string"},"addressLine5":{"description":"Address lines for foreign addresses","type":"string"},"country":{"description":"Country for foreign address","type":"string"},"countryCode":{"description":"Country code for foreign address","type":"string"}},"type":"object"},"ForeignPerson":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/ForeignPersonAddress"}],"description":"Address fields"},"personId":{"description":"Danish civil registration number - CPR number","type":"string"},"secrecyMarked":{"description":"Whether the person is secrecy marked","type":"boolean"}},"type":"object"},"ForeignPersonAddress":{"properties":{"foreignAddress":{"allOf":[{"$ref":"#/components/schemas/ForeignPersonForeignAddress"}],"description":"Foreign address fields"}},"type":"object"},"ForeignPersonForeignAddress":{"properties":{"addressLine1":{"description":"Address lines for foreign addresses","type":"string"},"addressLine2":{"description":"Address lines for foreign addresses","type":"string"},"addressLine3":{"description":"Address lines for foreign addresses","type":"string"},"addressLine4":{"description":"Address lines for foreign addresses","type":"string"},"addressLine5":{"description":"Address lines for foreign addresses","type":"string"},"country":{"description":"Country text for foreign address","type":"string"},"countryCode":{"description":"Country code for foreign address","type":"string"},"registrationDate":{"description":"Registration date of the foreign address","type":"string"}},"type":"object"},"ForeignPersonResults":{"description":"Roaring Group person foreign information results","properties":{"records":{"description":"found person foreign information results","items":{"$ref":"#/components/schemas/ForeignPerson"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"FraudAlertPerson":{"properties":{"fraudAlertStartDate":{"description":"The date and time of a fraud alert","type":"string"},"personId":{"description":"Danish civil registration number - CPR number","type":"string"}},"type":"object"},"FraudAlertPersonResults":{"description":"Roaring Group person fraud alert information results","properties":{"records":{"description":"found person fraud alert information results","items":{"$ref":"#/components/schemas/FraudAlertPerson"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"GuardianAddress":{"properties":{"addressLine1":{"description":"Address lines for the guardian address","type":"string"},"addressLine2":{"description":"Address lines for the guardian address","type":"string"},"addressLine3":{"description":"Address lines for the guardian address","type":"string"},"addressLine4":{"description":"Address lines for the guardian address","type":"string"},"addressLine5":{"description":"Address lines for the guardian address","type":"string"}},"type":"object"},"GuardianPerson":{"properties":{"guardianAddress":{"allOf":[{"$ref":"#/components/schemas/GuardianAddress"}],"description":"The address of the guardian"},"guardianName":{"description":"The name of the guardian","type":"string"},"personId":{"description":"Danish civil registration number - CPR number","type":"string"}},"type":"object"},"GuardianPersonResults":{"description":"Roaring Group person guardian information results","properties":{"records":{"description":"found person guardian information results","items":{"$ref":"#/components/schemas/GuardianPerson"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"Name":{"properties":{"firstName":{"description":"First name","type":"string"},"fullName":{"description":"Full name (both first and last name space separated)","type":"string"},"lastName":{"description":"Last name","type":"string"}},"type":"object"},"NationalRegistrationAddress":{"properties":{"address":{"description":"Address fields","type":"string"},"buildingNumber":{"description":"Building number, used on Greenland in place of house number","type":"string"},"coAddress":{"description":"c/o address","type":"string"},"doorPlacement":{"description":"Door placement","type":"string"},"floorNumber":{"description":"Floor number","type":"string"},"houseNumber":{"description":"House number","type":"string"},"locality":{"description":"Locality text, e.g. farm name","type":"string"},"municipalityCode":{"description":"Municipality code","type":"string"},"municipalityLong":{"description":"Municipality long text","type":"string"},"municipalityShort":{"description":"Municipality short text","type":"string"},"streetCode":{"description":"Street code","type":"string"},"streetText":{"description":"Street text","type":"string"},"town":{"description":"postal town","type":"string"},"village":{"description":"Village text","type":"string"},"zipCode":{"description":"Zip code","type":"string"}},"type":"object"},"Person":{"properties":{"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Address fields"},"birthDate":{"description":"Birth date","type":"string"},"birthDateUncertain":{"description":"Whether the birth date is unclear","type":"boolean"},"currentPersonId":{"description":"New personal identification number if it was changed for some reason.","type":"string"},"gender":{"description":"Gender code","type":"string"},"name":{"allOf":[{"$ref":"#/components/schemas/Name"}],"description":"Name fields"},"pendingChanges":{"description":"If there are pending changes to the CPR register","type":"boolean"},"personId":{"description":"Danish civil registration number - CPR number","type":"string"},"personStatus":{"allOf":[{"$ref":"#/components/schemas/PersonStatus"}],"description":"Status fields"},"secrecyMarked":{"description":"Whether the person is secrecy marked","type":"boolean"}},"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"},"PersonStatus":{"properties":{"code":{"description":"Person status code, shows for example if person is dead or has emigrated etc.","type":"string"},"fromDate":{"description":"Date from when status was set","type":"string"},"text":{"description":"Descriptive text for status code","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"},"text":{"description":"search result description","type":"string"}},"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"}},"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":{"description":"Person information\n\nAll 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>","title":"Person information","version":"1.1","x-logo":{"url":"https://assets.roaring.io/svg/person-v3.1.svg"}},"openapi":"3.0.1","paths":{"/current/{personId}":{"get":{"operationId":"viewCurrent","parameters":[{"description":"Danish civil registration number - CPR number","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentPersonResults"}}},"description":"OK, successfull 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"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}},"description":"Returned when authentication credentials are insufficient to grant access"},"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":"Fetch current information for a person","tags":["PersonDk"]}},"/foreign-address/{personId}":{"get":{"operationId":"viewForeign","parameters":[{"description":"Danish civil registration number - CPR number","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForeignPersonResults"}}},"description":"OK, successfull 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"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}},"description":"Returned when authentication credentials are insufficient to grant access"},"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":"Fetch foreign information for a person","tags":["PersonDk"]}},"/fraudalert/{personId}":{"get":{"operationId":"viewFraudAlert","parameters":[{"description":"Danish civil registration number - CPR number","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudAlertPersonResults"}}},"description":"OK, successfull 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":"Fetch the latest fraud alert date and time registered for the person","tags":["PersonDk"]}},"/guardian/{personId}":{"get":{"operationId":"viewGuardian","parameters":[{"description":"Danish civil registration number - CPR number","in":"path","name":"personId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardianPersonResults"}}},"description":"OK, successfull 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":"Fetch person guardian information","tags":["PersonDk"]}},"/{personalNumber}":{"get":{"operationId":"view","parameters":[{"description":"personal number","in":"path","name":"personalNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonResults"}}},"description":"OK, successfull 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"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}},"description":"Returned when authentication credentials are insufficient to grant access"},"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":"Fetch person information","tags":["PersonDk"]}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://api.roaring.io/dk/person/1.1"}],"x-category":"person","x-countries":["dk"],"x-id":"PersonApiDk"}