{"items":[{"type":"link","label":"Access","link":"/connect-apis-catalog/product-catalog/access/access","routeSlug":"/connect-apis-catalog/product-catalog/access/access","content":{"contentType":"overview","meta":{"name":"Access"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"access.json","url":"/_bundle/connect-apis-catalog/product-catalog/Access/@OAS3.1/access.json?download"},{"kind":"download","label":"access.yaml","url":"/_bundle/connect-apis-catalog/product-catalog/Access/@OAS3.1/access.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"attribute","title":"License","titleTranslationKey":"info.license","label":"Proprietary","value":"Proprietary"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Access (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API provides essential endpoints for user information and authentication, crucial for accessing and utilising any subsequent products."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authentication endpoint ensures secure access to the main API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user endpoints return comprehensive details about logged-in users within the customer's environment and provide higher-level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, the API allows users to view their subscriptions for available products and the languages that are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"OAS 3.0.4 Trial Availability"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use."},"children":[]}]}]}]}]}],"sectionId":"/connect-apis-catalog/product-catalog/access/access"}],"sectionId":"/connect-apis-catalog/product-catalog/access/access"}]}]}},{"type":"group","label":"Authentication","link":"/connect-apis-catalog/product-catalog/access/access/authentication","routeSlug":"/connect-apis-catalog/product-catalog/access/access/authentication","items":[{"label":"Authenticate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/access/access/authentication/authenticate","routeSlug":"/connect-apis-catalog/product-catalog/access/access/authentication/authenticate","metadata":{"seo":{"title":"Authenticate","description":"Supply username and password to generate Authentication Token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Authenticate","isWebhook":false,"pointer":"/paths/~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Supply username and password to generate Authentication Token.\n  \n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","pointer":"/paths/~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authenticate","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"responseCodes":["200","401"],"pointer":"/authenticate","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Authenticate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"schemaId":"components/schemas/ConnectAuthenticationAuthRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}},"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}},"schemaId":"components/schemas/ConnectAuthFailedResponse"}],"pointer":"/paths/~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAuthResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAuthResponse"}}},{"code":"401","schemaId":"components/schemas/ConnectAuthFailedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthFailedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/authenticate"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for user authentication into the Connect API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authenticate","summary":"Authenticate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false}]}]}]}]}},{"type":"group","label":"User Administration","link":"/connect-apis-catalog/product-catalog/access/access/user-administration","routeSlug":"/connect-apis-catalog/product-catalog/access/access/user-administration","items":[{"label":"Return Subscription Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/access/access/user-administration/subscriptiondetails","routeSlug":"/connect-apis-catalog/product-catalog/access/access/user-administration/subscriptiondetails","metadata":{"seo":{"title":"Return Subscription Details","description":"Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscriptionDetails","name":"Return Subscription Details","isWebhook":false,"pointer":"/paths/~1access/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Subscription Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the available countries in your subscription - Company Report, Director Report, Offline Reports and Monitoring."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/access","href":"user-administration/subscriptiondetails","openApiOperationId":"subscriptionDetails","summary":"Return Subscription Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAccessCountries"}},"schemaId":"components/schemas/ConnectAuthenticationAccessCountries"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}],"pointer":"/paths/~1access/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConnectAuthenticationAccessCountries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectAuthenticationAccessCountries"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-administration/subscriptiondetails"}],"panels":[]}]},"httpPath":"/access"},{"label":"Return List Of Active Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetactivecustomerusers","routeSlug":"/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetactivecustomerusers","metadata":{"seo":{"title":"Return List Of Active Users","description":"Returns a collection of user details with in the customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETActiveCustomerUsers","name":"Return List Of Active Users","isWebhook":false,"pointer":"/paths/~1access~1users~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return List Of Active Users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a collection of user details with in the customer"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access/users/active","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/access/users/active","href":"user-administration/protectgetactivecustomerusers","openApiOperationId":"protectGETActiveCustomerUsers","summary":"Return List Of Active Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse"}},"schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1access~1users~1active/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetCustomerUsersDetailsResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-administration/protectgetactivecustomerusers"}],"panels":[]}]},"httpPath":"/access/users/active"},{"label":"Return Logged In User Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetdetailsofloggedinuser","routeSlug":"/connect-apis-catalog/product-catalog/access/access/user-administration/protectgetdetailsofloggedinuser","metadata":{"seo":{"title":"Return Logged In User Details","description":"Returns the details of logged in user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"protectGETDetailsOfLoggedInUser","name":"Return Logged In User Details","isWebhook":false,"pointer":"/paths/~1access~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return Logged In User Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the details of logged in user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/access/users/me","servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/access/users/me","href":"user-administration/protectgetdetailsofloggedinuser","openApiOperationId":"protectGETDetailsOfLoggedInUser","summary":"Return Logged In User Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse"}},"schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}},"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}},"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}},"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}],"pointer":"/paths/~1access~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KycProtectGetMyUserDetailsResponse"}}},{"code":"400","schemaId":"components/schemas/ConnectErrorResponsesBadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesBadRequest"}}},{"code":"401","schemaId":"components/schemas/ConnectErrorResponsesInvalidToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesInvalidToken"}}},{"code":"403","schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesAccessForbidden"}}},{"code":"404","schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-administration/protectgetdetailsofloggedinuser"}],"panels":[]}]},"httpPath":"/access/users/me"}],"content":{"contentType":"group","meta":{"name":"User Administration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Administration","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for user management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/access","summary":"Return Subscription Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/subscriptiondetails","deprecated":false},{"title":"/access/users/active","summary":"Return List Of Active Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/protectgetactivecustomerusers","deprecated":false},{"title":"/access/users/me","summary":"Return Logged In User Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-administration/protectgetdetailsofloggedinuser","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ConnectAuthenticationAuthRequest":{"id":"components/schemas/ConnectAuthenticationAuthRequest","kind":"json-schema","title":"ConnectAuthenticationAuthRequest","data":{"type":"object","properties":{"username":{"type":"string","description":"Credentials assigned upon sign up","example":"username@domain.com"},"password":{"type":"string","example":"^1gHySRA56aj>tf421o"}}}},"components/schemas/ConnectAuthenticationAuthResponse":{"id":"components/schemas/ConnectAuthenticationAuthResponse","kind":"json-schema","title":"ConnectAuthenticationAuthResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"Authentication Token","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"}}}},"components/schemas/ConnectAuthFailedResponse":{"id":"components/schemas/ConnectAuthFailedResponse","kind":"json-schema","title":"ConnectAuthFailedResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Access denied -  Please check that your username and password are correct.  Please be aware that usernames and passwords are case sensitive. If the problem persists, please contact your Creditsafe account manager."}}},"components/schemas/ConnectAuthenticationAccessCountries":{"id":"components/schemas/ConnectAuthenticationAccessCountries","kind":"json-schema","title":"ConnectAuthenticationAccessCountries","data":{"type":"object","properties":{"correlationId":{"type":"string"},"countryAccess":{"type":"object","properties":{"creditsafeConnectOnlineReports":{"type":"array","description":"Country usage for Company Reports service","items":{"type":"object","properties":{"countryName":{"type":"string"},"templateName":{"type":"string","description":"Company Report template. Full reports are default"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectOfflineReports":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectMonitoring":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectDirectorReports":{"type":"array","items":{"type":"object","properties":{"countryName":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectImageDocuments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"countryIso2":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectBankValidation":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}},"creditsafeConnectBankVerification":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"startDate":{"type":"string","description":"Date of when the service was enabled"},"expireDate":{"type":"string","description":"Date of when the service will expire"},"paid":{"type":"integer","description":"Measure of total usage available in the service"},"used":{"type":"integer","description":"Service usage"}}}}}}}}},"components/schemas/ConnectErrorResponsesBadRequest":{"id":"components/schemas/ConnectErrorResponsesBadRequest","kind":"json-schema","title":"ConnectErrorResponsesBadRequest","data":{"type":"object","description":"Bad Request","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request."},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/ConnectErrorResponsesInvalidToken":{"id":"components/schemas/ConnectErrorResponsesInvalidToken","kind":"json-schema","title":"ConnectErrorResponsesInvalidToken","data":{"type":"object","properties":{"error":{"type":"string"}},"description":"401 - Authorization Token has either expired or is not a valid Connect Token"}},"components/schemas/KycProtectGetCustomerUsersDetailsResponse":{"id":"components/schemas/KycProtectGetCustomerUsersDetailsResponse","kind":"json-schema","title":"KycProtectGetCustomerUsersDetailsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the user.","example":"connect"},"surname":{"type":"string","description":"Surname name of the user.","example":"connect"},"userId":{"type":"integer","description":"Id of the user.","format":"int32","example":101534481}}}},"totalSize":{"type":"integer","format":"int64"}}}},"components/schemas/ConnectErrorResponsesAccessForbidden":{"id":"components/schemas/ConnectErrorResponsesAccessForbidden","kind":"json-schema","title":"ConnectErrorResponsesAccessForbidden","data":{"type":"object","description":"403 - Access Forbidden","properties":{"message":{"type":"string","example":"Access forbidden"}}}},"components/schemas/ConnectErrorResponsesResourceNotFoundRequest":{"id":"components/schemas/ConnectErrorResponsesResourceNotFoundRequest","kind":"json-schema","title":"ConnectErrorResponsesResourceNotFoundRequest","data":{"type":"object","description":"404 - Not Found","properties":{"correlationId":{"type":"string","description":"A unique ID assigned to this request.","format":"uuid"},"message":{"type":"string"},"details":{"type":"string","description":"Provides further information on why the request was rejected"}}}},"components/schemas/KycProtectGetMyUserDetailsResponse":{"id":"components/schemas/KycProtectGetMyUserDetailsResponse","kind":"json-schema","title":"KycProtectGetMyUserDetailsResponse","data":{"type":"object","properties":{"username":{"type":"string","description":"The name of the user.","example":"Raj"},"emailAddress":{"type":"string","description":"The email address of the user.","example":"connectm1@mailinator.com"},"owningEntity":{"type":"string","description":"Owning entity of the user.","example":"CSUS"},"defaultLanguage":{"type":"string","description":"user default language.","example":"EN"},"primaryContact":{"type":"object","properties":{"title":{"type":"string","description":"Title of the user primary contact.","example":""},"firstName":{"type":"string","description":"firstName of the user primary contact.","example":""},"surname":{"type":"string","description":"surname of the user primary contact.","example":""}}},"ietfLanguage":{"type":"string","description":"user default language.","example":"en-GB"},"countryCode":{"type":"string","description":"country code of the user.","example":"en-GB"},"isActive":{"type":"string","description":"status of the user.","example":true},"correlationId":{"type":"string","description":"A unique ID assigned to this request.","example":"23921650-c073-11ea-860f-06bc8182190e"}}}}},"exampleStore":{},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API requires authentication for access to protected endpoints. Authentication is performed by providing a valid JWT token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]}]}]}]}},"servers":[{"url":"https://connect.sandbox.creditsafe.com/v1","description":"Sandbox server"},{"url":"https://connect.creditsafe.com/v1","description":"Production server"}]},"options":{"feedback":{"type":"mood","settings":{"optionalEmail":{"hide":true},"label":"Do you like this page?","submitText":"Thanks for your feedback - Your comments will shape documentation changes.","reasons":{"label":"Check all boxes that apply.","items":["The content was useful.","The content was easy to find.","The content could do with improvement."]},"comment":{"satisfiedLabel":"What did you like best?","neutralLabel":"How can we improve?","dissatisfiedLabel":"What needs improvement?"}}},"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/connect-apis-catalog/product-catalog/access/access","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connect-apis-catalog/product-catalog/Access/@OAS3.1/access.json?download"},{"url":"/_bundle/connect-apis-catalog/product-catalog/Access/@OAS3.1/access.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Access","description":"\nThis API provides essential endpoints for user information and authentication, crucial for accessing and utilising any subsequent products. \n\nThe authentication endpoint ensures secure access to the main API. \n\nThe user endpoints return comprehensive details about logged-in users within the customer's environment and provide higher-level \nuser information. \n\nAdditionally, the API allows users to view their subscriptions for available products and the languages that are supported.\n\n{% admonition type=\"info\" name=\"OAS 3.0.4 Trial Availability\" %}\nThe OAS 3.0.4 version of this API specification is provided for trial purposes only. While every effort is made to ensure its accuracy, the OAS 3.1.0 version is the primary managed and maintained specification and is recommended for all integrations and production use.\n{% /admonition %}\n","status":"published","tags":["Authentication"]}},"baseSlug":"/connect-apis-catalog/product-catalog/access/access","routesMapping":{}}