{"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"},"Name":{"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"nameID":{"format":"int32","type":"integer"},"nameType":{"type":"string"},"nameTypeId":{"format":"int32","type":"integer"}},"type":"object"},"PaginationInfo":{"description":"Pagination metadata for paginated history responses","properties":{"maxPageSize":{"description":"Maximum pageSize the server will honor for this entity. 0 means no restriction. Clients may request any pageSize up to this value; values above are silently capped.","format":"int32","type":"integer"},"page":{"description":"Current page number (1-indexed)","format":"int32","type":"integer"},"pageSize":{"description":"Effective records per page (may be less than requested if auto-capped)","format":"int32","type":"integer"},"paginationToken":{"description":"HMAC-signed token for follow-up pages (provides free billing and cached counts)","type":"string"},"totalPages":{"description":"Total number of pages available at the current pageSize","format":"int32","type":"integer"},"totalRecords":{"description":"Total records matching the query","format":"int32","type":"integer"}},"type":"object"},"Pep":{"description":"Politically Exposed Person","properties":{"birthDate":{"type":"string"},"birthDateDay":{"format":"int32","type":"integer"},"birthDateMonth":{"format":"int32","type":"integer"},"birthDateYear":{"format":"int32","type":"integer"},"eventPayloadPersonalNumber":{"type":"string"},"gender":{"type":"string"},"hitCount":{"format":"int32","type":"integer"},"hits":{"items":{"type":"string"},"type":"array"},"houseNumber":{"type":"string"},"imageLink":{"type":"string"},"names":{"items":{"$ref":"#/components/schemas/Name"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"pep":{"type":"boolean"},"pepCountries":{"items":{"type":"string"},"type":"array"},"pepLastPEPRoleEndDate":{"type":"string"},"personId":{"format":"int32","type":"integer"},"postalAddress":{"type":"string"},"postalAddress2":{"type":"string"},"postalCity":{"type":"string"},"postalCountry":{"type":"string"},"rca":{"type":"boolean"},"rcaLastPEPRoleEndDate":{"type":"string"},"relations":{"items":{"$ref":"#/components/schemas/Relation"},"type":"array"},"responseInfo":{"$ref":"#/components/schemas/ResponseInfo"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array"},"ssns":{"items":{"$ref":"#/components/schemas/Ssn"},"type":"array"},"status":{"$ref":"#/components/schemas/SearchResultStatus"},"zipCode":{"type":"string"}},"type":"object"},"PepWrapper":{"properties":{"hitCount":{"format":"int32","type":"integer"},"hits":{"items":{"$ref":"#/components/schemas/Pep"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"responseInfo":{"$ref":"#/components/schemas/ResponseInfo"},"status":{"$ref":"#/components/schemas/SearchResultStatus"}},"type":"object"},"Relation":{"properties":{"fromDateDay":{"format":"int32","type":"integer"},"fromDateMonth":{"format":"int32","type":"integer"},"fromDateYear":{"format":"int32","type":"integer"},"relationDescription":{"type":"string"},"relationId":{"format":"int32","type":"integer"},"relationPersonId":{"format":"int32","type":"integer"},"relationType":{"type":"string"},"relationTypeId":{"format":"int32","type":"integer"}},"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"},"ResponseInfo":{"properties":{"hitCount":{"format":"int32","type":"integer"},"noMatchIds":{"items":{"type":"string"},"type":"array"},"requestCount":{"format":"int32","type":"integer"}},"type":"object"},"Role":{"properties":{"active":{"type":"boolean"},"baseRoleCategoryId":{"format":"int32","type":"integer"},"baseRoleCategoryName":{"type":"string"},"countryOfJurisdiction":{"type":"string"},"detailedRoleCategoryId":{"format":"int32","type":"integer"},"detailedRoleCategoryName":{"type":"string"},"fromDateDay":{"format":"int32","type":"integer"},"fromDateMonth":{"format":"int32","type":"integer"},"fromDateYear":{"format":"int32","type":"integer"},"roleDescription":{"type":"string"},"roleID":{"format":"int32","type":"integer"},"throughDateDay":{"format":"int32","type":"integer"},"throughDateMonth":{"format":"int32","type":"integer"},"throughDateYear":{"format":"int32","type":"integer"}},"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"},"Ssn":{"properties":{"currentSsn":{"type":"string"},"previousSsn":{"type":"string"},"ssnType":{"type":"string"},"ssnTypeId":{"format":"int32","type":"integer"}},"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":"Contains information about all politically exposed persons in the Nordics. Used for Know Your Customer, customer registration, etc.\n\n* Anti Money Laundering (AML)\n* Know Your Customer (KYC)\n* Compliance\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":"Pep","version":"1.1","x-logo":{"url":"https://assets.roaring.io/svg/PEP-person-v3.1.svg"}},"openapi":"3.0.1","paths":{"/person/{pepId}":{"get":{"operationId":"view","parameters":[{"description":"Id of a pep entity","in":"path","name":"pepId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pep"}}},"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":"Fetch pep","tags":["Pep"]}},"/search":{"get":{"description":"Search pep matching query string parameters.","operationId":"view_1","parameters":[{"description":"Filter indicating if the results should include PEP's","in":"query","name":"pep","schema":{"type":"boolean"}},{"description":"Filter indicating if the results should include RCA's","in":"query","name":"rca","schema":{"type":"boolean"}},{"description":"Country to check pep in (ISO 3166-1 alpha-2 standard)","explode":true,"in":"query","name":"countryCode","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Personal number identifier (SSN) from the country of interest","in":"query","name":"personalNumber","schema":{"type":"string"}},{"description":"First name of a person to search for","in":"query","name":"firstName","schema":{"type":"string"}},{"description":"Last name of a person to search for","in":"query","name":"lastName","schema":{"type":"string"}},{"description":"Full name of a person to search for","in":"query","name":"fullName","schema":{"type":"string"}},{"description":"Date of birth of the searched entity, should match (ISO 8601 format)","in":"query","name":"birthDate","schema":{"type":"string"}},{"description":"Gender of the searched entity, can be male or female","in":"query","name":"gender","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PepWrapper"}}},"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":"Search for a single pep","tags":["Pep"]}}},"security":[{"OAuth2":[]}],"servers":[{"url":"https://api.roaring.io/nordic/pep/1.1"}],"x-category":"person","x-countries":["dk","fi","no","se"],"x-id":"Pep","x-locale-da":{"description":"Check if the person is registered as PEP (Politically Exposed Person)","name":"Politically Exposed Person (PEP)"},"x-locale-en":{"description":"Check if the person is registered as PEP (Politically Exposed Person)","name":"Politically Exposed Person (PEP)"},"x-locale-no":{"description":"Sjekk om personen er registrert som PEP (Politisk Eksponert Person)","name":"Politisk Eksponert Person (PEP)"},"x-locale-sv":{"description":"Kontrollera om personen är registrerad som PEP (Politiskt Exponerad Person)","name":"Politiskt Exponerad Person (PEP)"},"x-logo":{"url":"https://roaring-assets.s3-eu-west-1.amazonaws.com/svg/PEP-person.svg"}}