{"swagger":"2.0","info":{"version":"BAT1","title":"204837-bat-dante-swagger"},"basePath":"/","schemes":["https"],"paths":{"/profiles/checkout":{"post":{"consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"CheckoutInput","required":true,"schema":{"$ref":"#/definitions/CheckoutInput"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/CheckoutOutput"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/Error"}},"401":{"description":"Unauthorized error","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Error"}},"415":{"description":"Unsupported media type","schema":{"$ref":"#/definitions/Error"}},"408":{"description":"Request timed out","schema":{"$ref":"#/definitions/Error"}}},"security":[{"api_key":[]}]}},"/profiles/deactivate":{"post":{"consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"DeactivateInput","required":true,"schema":{"$ref":"#/definitions/DeactivateInput"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/JobIdOutput"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/Error"}},"401":{"description":"Unauthorized error","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Error"}},"415":{"description":"Unsupported media type","schema":{"$ref":"#/definitions/Error"}},"408":{"description":"Request timed out","schema":{"$ref":"#/definitions/Error"}}},"security":[{"api_key":[]}]}},"/profiles/deactivate/{jobId}":{"get":{"consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"detailed","in":"query","required":false,"type":"string"},{"name":"jobId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/DeactivateDetailsOutput"}},"401":{"description":"Unauthorized error","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Error"}},"415":{"description":"Unsupported media type","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"Resource not found","schema":{"$ref":"#/definitions/Error"}},"408":{"description":"Request timed out","schema":{"$ref":"#/definitions/Error"}}},"security":[{"api_key":[]}]}},"/profiles/undo-checkout":{"post":{"consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"UndoCheckoutInput","required":true,"schema":{"$ref":"#/definitions/UndoCheckoutInput"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/UndoCheckoutOuput"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/Error"}},"401":{"description":"Unauthorized error","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Error"}},"415":{"description":"Unsupported media type","schema":{"$ref":"#/definitions/Error"}},"408":{"description":"Request timed out","schema":{"$ref":"#/definitions/Error"}}},"security":[{"api_key":[]}]}},"/profiles":{"post":{"consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"GetProfilesInput","required":true,"schema":{"$ref":"#/definitions/GetProfilesInput"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/GetProfilesOutput"}},"401":{"description":"Unauthorized error","schema":{"$ref":"#/definitions/Error"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Error"}},"415":{"description":"Unsupported media type","schema":{"$ref":"#/definitions/Error"}},"404":{"description":"Resource not found","schema":{"$ref":"#/definitions/Error"}},"408":{"description":"Request timed out","schema":{"$ref":"#/definitions/Error"}}},"security":[{"api_key":[]}]}},"/health":{"get":{"tags":["Health Check"],"description":"This interface is used to check the healthty of Dante service.\n","produces":["application/json"],"responses":{"200":{"description":"A body block that contains the Dantes's service health status\nand a list of health statuses of services it depends on.\n","schema":{"$ref":"#/definitions/HealthCheckResponse"},"examples":{"ok_status":"{\n  \"status\": \"OK\",\n  \"details\": [\n    {\n      \"service\": \"Database\",\n      \"status\": \"OK\",\n      \"output\": \"system is running\"\n    }\n  ]\n}\n"}},"503":{"description":"Service Unavailable","schema":{"$ref":"#/definitions/HealthCheckResponse"},"examples":{"failed_status":"{\n  \"status\": \"FAILED\",\n  \"details\": [\n    {\n      \"service\": \"Database\",\n      \"status\": \"FAILED\",\n      \"output\": \"system is down\"\n    }\n  ]\n}\n"}}}}}},"securityDefinitions":{"api_key":{"type":"apiKey","name":"x-api-key","in":"header"}},"definitions":{"DeactivateDetailsOutput":{"type":"array","items":{"type":"object","title":"The Details Schema","properties":{"profileId":{"type":"string","title":"The ProfileId Schema"},"status":{"type":"string","title":"The Status Schema","enum":["SUCCEEDED","IN_PROGRESS","FAILED"]},"reason":{"type":"string","title":"The Reason Schema"}},"required":["profileId","status"]},"title":"The DeactivateDetailsOutput Schema"},"CheckoutInput":{"type":"object","required":["profiles"],"properties":{"profiles":{"type":"array","title":"The Profile UIDs/User Schema","items":{"type":"object","title":"Checkout item schema","properties":{"profileId":{"type":"integer","title":"The Uid Schema"},"user":{"type":"string","title":"User ID"}}}}},"title":"The CheckoutInput Schema"},"DeactivateInput":{"type":"object","required":["profiles"],"properties":{"profiles":{"type":"array","title":"The Profiles Schema","items":{"type":"object","title":"The Items Schema","properties":{"uid":{"type":"integer","title":"The Uid Schema"},"deactivationReason":{"type":"string","title":"The Deactivation Reason Schema"},"deactivationRemark":{"type":"string","title":"The Deactivation Remark Schema"},"deactivationInvestigator":{"type":"string","title":"The Deactivationinvestigator Schema"},"qaApprover":{"type":"string","title":"The Qa Approver Schema"},"qaOutcome":{"type":"string","title":"The Qa Outcome Schema"},"qaRemark":{"type":"string","title":"The Qa Remark Schema"},"finalOutcome":{"type":"string","title":"The Final Outcome Schema"}},"required":["deactivationInvestigator","deactivationRemark","deactivationReason","qaApprover","uid"]}}},"title":"The DeactivateInput Schema"},"JobIdOutput":{"type":"object","required":["jobId"],"properties":{"jobId":{"type":"string","title":"The Jobid Schema"}},"title":"The JobIdOutput Schema"},"CheckoutOutput":{"type":"array","items":{"type":"object","title":"The Items Schema","properties":{"profileId":{"type":"integer","title":"The Uid Schema"},"status":{"type":"string","title":"The Status Schema","enum":["SUCCEEDED","FAILED"]},"reason":{"type":"string","title":"The Reason Schema"}},"required":["status","profileId"]},"title":"The CheckoutOutput Schema"},"Error":{"type":"object","properties":{"message":{"type":"string"}},"title":"Error Schema"},"UndoCheckoutInput":{"type":"object","required":["profiles"],"properties":{"profiles":{"type":"array","title":"The Profile UIDs/User Schema","items":{"type":"object","title":"Undo Checkout item schema","properties":{"profileId":{"type":"integer","title":"The Uid Schema"},"user":{"type":"string","title":"User ID"}}}}},"title":"The UndoCheckoutInput Schema"},"UndoCheckoutOuput":{"type":"object","required":["details","status"],"properties":{"status":{"type":"string","title":"The Status Schema","enum":["SUCCEEDED","FAILED"]},"details":{"type":"array","title":"The Details Schema","items":{"type":"object","title":"The Items Schema","properties":{"uid":{"type":"integer","title":"The Uid Schema"},"status":{"type":"string","title":"The Status Schema","enum":["SUCCEEDED","FAILED"]},"reason":{"type":"string","title":"The Reason Schema"}},"required":["status","uid"]}}},"title":"The UndoCheckoutOuput Schema"},"GetProfilesOutput":{"type":"object","properties":{"profiles":{"type":"array","items":{"$ref":"#/definitions/Profile"}},"nonExistentProfileIds":{"items":{"type":"integer"}}}},"GetProfilesInput":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"integer"}}}},"PartiallyKnownDate":{"type":"object","properties":{"day":{"type":["integer","null"],"title":"Date day","minimum":1,"maximum":31},"month":{"type":["integer","null"],"title":"Date month","minimum":1,"maximum":12},"year":{"type":["integer","null"],"title":"Date year","minimum":0}}},"Profile":{"title":"Profile","type":"object","required":["uid","version","status","firstName","lastName","profileTypeId","lastReviewedDateTime","linkedUIDs","additionalInformation","subCategoryId","officialLists","categories","locations","citizenships","sources","isRegulatoryRecord","isProtectedRecord","blackListedProfile","inActive","createdBy","createdDate","checkoutFlag","checkedOutBy","checkedOutDate","approverUserId","submittedForApproval","publishedDate","updCategory","referenceNumber","taskOutCome","isBatchUpdate","isIranIeiRecord","isIndirectChange","isRegulatoryArchive","inActiveInfo","permId","crNumber","activityType","worldCheckPermId","isDuplicateConfirmed","isSubmitNoTag","noIdentifier","isInsae"],"properties":{"uid":{"type":"integer","title":"Uid"},"version":{"type":"integer","title":"Version"},"status":{"type":"integer","title":"Status"},"firstName":{"type":["string","null"],"title":"First Name"},"lastName":{"type":"string","title":"Last Name"},"profileTypeId":{"type":"integer","title":"Status"},"aliases":{"type":"array","items":{"type":"object","required":["alias","languageCode","aliasType"],"properties":{"alias":{"type":"string","title":"Alias"},"languageCode":{"type":"string","title":"Language Code"},"aliasType":{"type":"string","enum":["Alias","LQA","NativeAlias","AlternateSpelling"],"title":"Language Code"}}}},"titles":{"type":"array","items":{"type":"object","required":["titleId","default"],"properties":{"titleId":{"type":"integer","title":"Title ID"},"default":{"type":"boolean"}}}},"positions":{"type":"array","items":{"type":"object","required":["position"],"properties":{"position":{"type":"string"}}}},"alternateAges":{"type":"array","items":{"type":"object","required":["profileAge","ageDate","default"],"properties":{"profileAge":{"type":"integer"},"ageDate":{"type":"string","pattern":"^(.*)$"},"default":{"type":"boolean"}}}},"dobs":{"type":"array","items":{"type":"object","required":["default"],"properties":{"dob":{"type":"string","pattern":"^(.*)$"},"default":{"type":"boolean"},"birthMonthYear":{"$ref":"#/definitions/PartiallyKnownDate"}}}},"deceasedMonthYear":{"$ref":"#/definitions/PartiallyKnownDate"},"deceased":{"type":["string","null"],"pattern":"^(.*)$"},"placeOfBirth":{"type":["string","null"]},"additionalInformation":{"type":"string"},"categories":{"type":"array","items":{"type":"object","required":["categoryId","default"],"properties":{"categoryId":{"type":"integer"},"default":{"type":"boolean"}}}},"subCategoryId":{"type":"integer"},"passports":{"type":"array","items":{"type":"object","required":["passportNumber","countryId"],"properties":{"countryId":{"type":"integer"},"passportNumber":{"type":"string"}}}},"universalIds":{"type":"array","items":{"type":"object","required":["universalId","locTypeId"],"properties":{"locTypeId":{"type":"integer"},"universalId":{"type":"string"}}}},"idNumbers":{"type":"array","items":{"type":"object","required":["idNumber"],"properties":{"idNumber":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","required":["countryId"],"properties":{"countryId":{"type":"integer"},"cityId":{"type":["integer","null"]},"stateId":{"type":["integer","null"]},"asis":{"type":"string"}}}},"citizenships":{"type":"array","items":{"type":"object","required":["citizenshipCountryId","default"],"properties":{"citizenshipCountryId":{"type":"integer"},"default":{"type":"boolean"}}}},"sources":{"type":"array","items":{"type":"object","required":["url","image","link","isInternal","isSingleSource","ofiicialSource","createdDate"],"properties":{"url":{"type":"string"},"image":{"type":"boolean"},"link":{"type":"boolean"},"footNote":{"type":["string","null"]},"description":{"type":"string"},"cachedURL":{"type":"string"},"documentGUID":{"type":"string"},"isInternal":{"type":"boolean"},"isSingleSource":{"type":"boolean"},"officialSource":{"type":"boolean"},"createdDate":{"type":"string","pattern":"^(.*)$"}}}},"officialLists":{"type":"array","items":{"type":"object","required":["officialListId"],"properties":{"idNumber":{"type":"integer"}}}},"tags":{"type":"array","items":{"type":"object","required":["tagId"],"properties":{"tagId":{"type":"integer"}}}},"reviewerComments":{"type":["string","null"]},"researcherComments":{"type":"string"},"pepStatus":{"type":["integer","null"]},"pepRoles":{"type":"array","items":{"type":"object","properties":{"pepRoleId":{"type":"integer"},"pepRoleBio":{"type":"string"},"termStartDate":{"$ref":"#/definitions/PartiallyKnownDate"},"termEndDate":{"$ref":"#/definitions/PartiallyKnownDate"},"termLength":{"type":"integer"},"createdDate":{"type":"string","pattern":"^(.*)$"},"parent_pepId":{"type":"integer"},"isTermStartDtReported":{"type":"boolean"},"isTermEndDtReported":{"type":"boolean"},"isTermStartDtUnknown":{"type":"boolean"},"pepRoleStatusId":{"type":"integer"},"sentenceNumber":{"type":"integer"},"isDefault":{"type":"boolean"}}}},"nonPeproles":{"type":"array","items":{"type":"object","required":["nonPeprole","termStartDate","termEndDate","isTermStartDtReported","isTermEndDtReported","isTermStartDtUnknown","nonPepRoleStatusId","sentenceNumber"],"properties":{"nonPeprole":{"type":"string"},"termStartDate":{"$ref":"#/definitions/PartiallyKnownDate"},"termEndDate":{"$ref":"#/definitions/PartiallyKnownDate"},"isTermStartDtReported":{"type":"boolean"},"isTermEndDtReported":{"type":"boolean"},"isTermStartDtUnknown":{"type":"boolean"},"nonPepRoleStatusId":{"type":"integer"},"sentenceNumber":{"type":"integer"}}}},"isRegulatoryRecord":{"type":"boolean"},"isProtectedRecord":{"type":"boolean"},"blackListedProfile":{"type":"boolean"},"inActive":{"type":"boolean"},"createdBy":{"type":"integer"},"createdDate":{"type":"string","pattern":"^(.*)$"},"checkoutFlag":{"type":"boolean"},"checkedOutBy":{"type":["string","null"]},"checkedOutDate":{"type":["string","null"],"pattern":"^(.*)$"},"approverUserId":{"type":"integer"},"submittedForApproval":{"type":"boolean"},"publishedDate":{"type":"string","pattern":"^(.*)$"},"updCategory":{"type":["integer","null"]},"referenceNumber":{"type":["string","null"]},"taskOutCome":{"type":"integer"},"isBatchUpdate":{"type":"boolean"},"isIranIeiRecord":{"type":"boolean"},"isIndirectChange":{"type":"boolean"},"isRegulatoryArchive":{"type":"boolean"},"inActiveInfo":{"type":"integer"},"permId":{"type":["string","null"]},"crNumber":{"type":["string","null"]},"activityType":{"type":["string","null"]},"worldCheckPermId":{"type":"integer","format":"int64"},"isDuplicateConfirmed":{"type":"boolean"},"isSubmitNoTag":{"type":"boolean"},"noIdentifier":{"type":"boolean"},"isInsae":{"type":"boolean"},"linkedUids":{"type":"array","items":{"type":"object","required":["linkedUid"],"properties":{"linkedUid":{"type":"integer"}}}},"linkedCompanies":{"type":"array","items":{"type":"string"}},"lastReviewedDateTime":{"type":"string","pattern":"^(.*)$"},"attachments":{"type":"array","items":{"type":"object","required":["filetypeId","filepath","description","footNote","attachmentSubTypeTypeId","uploadFileName","attachmentTypeId"],"properties":{"filetypeId":{"type":"integer"},"filepath":{"type":"string"},"description":{"type":"string"},"footNote":{"type":"string"},"attachmentSubTypeTypeId":{"type":"integer"},"uploadFileName":{"type":"string"},"attachmentTypeId":{"type":"integer"}}}}}},"HealthCheckResponse":{"type":"object","properties":{"status":{"type":"string"},"details":{"type":"array","items":{"properties":{"service":{"type":"string"},"status":{"type":"string"},"output":{"type":"string"}}}}}}}}