{"items":[{"type":"link","label":"Authorization","link":"/openapi/token.openapi","routeSlug":"/openapi/token.openapi","content":{"contentType":"overview","meta":{"name":"Authorization"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"token.openapi.json","url":"/_bundle/openapi/token.openapi.json?download"},{"kind":"download","label":"token.openapi.yaml","url":"/_bundle/openapi/token.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Authorization","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":"Obtain client access tokens for API authorization when needed (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/api_ref_intro/#authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the API explorer below to generate access tokens directly from the docs. You can then use these tokens to run API requests in this API reference."},"children":[]}]}]}]}],"sectionId":"/openapi/token.openapi"}],"sectionId":"/openapi/token.openapi"}]}]}},{"label":"Get client access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/token.openapi/other/getaccesstoken","routeSlug":"/openapi/token.openapi/other/getaccesstoken","metadata":{"seo":{"title":"Get client access token","description":"Retrieve an access token to authorize your API request. By default, the access token is valid for 1 hour, you don't need to regenerate it every time before calling Mosaic APIs.  NOTE: The request type and examples depend on the service you choose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccessToken","name":"Get client access token","isWebhook":false,"pointer":"/paths/~1oidc~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an access token to authorize your API request. By default, the access token is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"valid for 1 hour"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you don't need to regenerate it every time before calling Mosaic APIs. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: The request type and examples depend on the service you choose"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_271"}},"schemaId":"schema_271","pointer":"/paths/~1oidc~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oidc/token","servers":[{"url":"https://api.sbx.transmitsecurity.io","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_271"}},"responseCodes":["200","400","500"],"pointer":"/oidc/token","href":"other/getaccesstoken","openApiOperationId":"getAccessToken","summary":"Get client access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io","description":"JP production environment"}],"schemaId":"schema_271","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_271"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access token successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}},"schemaId":"schema_272"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerHttpError"}},"schemaId":"components/schemas/InternalServerHttpError"}],"pointer":"/paths/~1oidc~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_272","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"500","schemaId":"components/schemas/InternalServerHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/oidc/token"}],"store":{"schemaStore":{"components/schemas/Identity Verification only":{"id":"components/schemas/Identity Verification only","kind":"json-schema","title":"Identity Verification only","data":{"type":"object","properties":{"client_id":{"type":"string","description":"Client identifier"},"client_secret":{"type":"string","description":"Client secret"},"grant_type":{"type":"string","enum":["client_credentials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be set to client_credentials."},"children":[]}]}]}]},"resource":{"type":"string","enum":["https://verify.identity.security"],"description":"URI of the resource the request is attempting to access."}},"required":["client_id","client_secret","grant_type"],"example":{"client_id":"YOUR_CLIENT_ID","client_secret":"YOUR_CLIENT_SECRET","grant_type":"client_credentials","resource":"https://verify.identity.security"}}},"components/schemas/Default":{"id":"components/schemas/Default","kind":"json-schema","title":"Default","data":{"type":"object","properties":{"client_id":{"type":"string","description":"Client identifier"},"client_secret":{"type":"string","description":"Client secret"},"grant_type":{"type":"string","enum":["client_credentials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grant type must be client_credentials."},"children":[]}]}]}]},"resource":{"type":"string","description":"URI of the resource the request is attempting to access."}},"required":["client_id","client_secret","grant_type"],"example":{"client_id":"YOUR_CLIENT_ID","client_secret":"YOUR_CLIENT_SECRET","grant_type":"client_credentials"}}},"components/schemas/BadRequestHttpError":{"id":"components/schemas/BadRequestHttpError","kind":"json-schema","title":"BadRequestHttpError","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Bad request"},"error_code":{"type":"number","readOnly":true,"example":400}},"required":["message","error_code"]}},"components/schemas/InternalServerHttpError":{"id":"components/schemas/InternalServerHttpError","kind":"json-schema","title":"InternalServerHttpError","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Something went wrong - Internal server error"},"error_code":{"type":"number","readOnly":true,"example":500}},"required":["message","error_code"]}},"schema_271":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Default"},{"$ref":"#/components/schemas/Identity Verification only"}]},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"object","properties":{"access_token":{"type":"string","description":"The access token issued by the authorization server"},"token_type":{"type":"string","description":"Returned as Bearer","example":"Bearer"},"expires_in":{"type":"integer","description":"Expiration time of the access token in seconds","default":3600,"example":3600},"scope":{"type":"string","description":"Scope of the access token"}},"required":["access_token","token_type","expires_in","scope"]},"id":"schema_272"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.sbx.transmitsecurity.io","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/token.openapi.json?download"},{"url":"/_bundle/openapi/token.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Authorization","description":"Obtain client access tokens for API authorization when needed (see [Authentication](/openapi/api_ref_intro/#authentication)). Click **Try it** from the API explorer below to generate access tokens directly from the docs. You can then use these tokens to run API requests in this API reference."}},"baseSlug":"/openapi/token.openapi","routesMapping":{}}