{"items":[{"type":"link","label":"Mobile Biometrics","link":"/openapi/user/backend-mobile-biometrics.openapi","routeSlug":"/openapi/user/backend-mobile-biometrics.openapi","content":{"contentType":"overview","meta":{"name":"Mobile Biometrics"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"backend-mobile-biometrics.openapi.json","url":"/_bundle/openapi/user/backend-mobile-biometrics.openapi.json?download"},{"kind":"download","label":"backend-mobile-biometrics.openapi.yaml","url":"/_bundle/openapi/user/backend-mobile-biometrics.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/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Mobile Biometrics","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Login users with native mobile biometrics. This process relies on the device ability to leverage built-in biometric sensors. To support mobile biometrics in the app, first implement the SDK call that creates an authenticator (cryptographic key-pair) on the end-user device and then register this authenticator with Transmit. The private key remains securely stored on the device and protected by biometrics, while the public key is registered with Transmit for a given user. To authenticate, the device uses mobile biometrics to access the private key and to sign a challenge that gets verified by Transmit. Note: registration and authentication are two-step procedures that start by calling the client-side SDK provided by Transmit, and complete using these APIs."}],"sectionId":"/openapi/user/backend-mobile-biometrics.openapi"}],"sectionId":"/openapi/user/backend-mobile-biometrics.openapi"}]}]}},{"label":"Create mobile biometrics challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-mobile-biometrics.openapi/other/nativemobilebiometricsbackendinitialize","routeSlug":"/openapi/user/backend-mobile-biometrics.openapi/other/nativemobilebiometricsbackendinitialize","metadata":{"seo":{"title":"Create mobile biometrics challenge","description":"Creates a challenge for the user to sign for the mobile biometrics flow."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"nativeMobileBiometricsBackendInitialize","name":"Create mobile biometrics challenge","isWebhook":false,"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create mobile biometrics challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a challenge for the user to sign for the mobile biometrics flow."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"schemaId":"schema_330","pointer":"/paths/~1v1~1auth~1mobile-biometrics~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/mobile-biometrics/start","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_330"}},"responseCodes":["200"],"pointer":"/v1/auth/mobile-biometrics/start","href":"other/nativemobilebiometricsbackendinitialize","openApiOperationId":"nativeMobileBiometricsBackendInitialize","summary":"Create mobile biometrics challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"schema_330","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backend auth initialized successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiNativeMobileBiometricsStartResponseDto"}},"schemaId":"components/schemas/ApiNativeMobileBiometricsStartResponseDto"}],"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiNativeMobileBiometricsStartResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiNativeMobileBiometricsStartResponseDto"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/mobile-biometrics/start"},{"label":"Authenticate with mobile biometrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-mobile-biometrics.openapi/other/authenticatenativemobilebiometrics","routeSlug":"/openapi/user/backend-mobile-biometrics.openapi/other/authenticatenativemobilebiometrics","metadata":{"seo":{"title":"Authenticate with mobile biometrics","description":"Completes authentication in Transmit. Before calling this API, invoke the client-side SDK provided by Transmit to sign a challenge using the private key stored by the device, which only occurs after the user verifies themselves with biometrics. Returns an access token for the user associated with the key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateNativeMobileBiometrics","name":"Authenticate with mobile biometrics","isWebhook":false,"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate with mobile biometrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes authentication in Transmit. Before calling this API, invoke the client-side SDK provided by Transmit to sign a challenge using the private key stored by the device, which only occurs after the user verifies themselves with biometrics. Returns an access token for the user associated with the key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331","pointer":"/paths/~1v1~1auth~1mobile-biometrics~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/mobile-biometrics/authenticate","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_331"}},"responseCodes":["200","400"],"pointer":"/v1/auth/mobile-biometrics/authenticate","href":"other/authenticatenativemobilebiometrics","openApiOperationId":"authenticateNativeMobileBiometrics","summary":"Authenticate with mobile biometrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns user tokens","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenResponse"}},"schemaId":"components/schemas/ApiTokenResponse"},{"code":"400","description":"Invalid signature, user not found, or session not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"}],"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenResponse"}}},{"code":"400","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/mobile-biometrics/authenticate"},{"label":"Register mobile biometrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-mobile-biometrics.openapi/other/mobile-biometrics-registration","routeSlug":"/openapi/user/backend-mobile-biometrics.openapi/other/mobile-biometrics-registration","metadata":{"seo":{"title":"Register mobile biometrics","description":"Completes mobile biometrics registration in Transmit. Before calling this API, create an authenticator (cryptographic key-pair) on the end-user's device by invoking the client-side SDK provided by Transmit. This API must be called from the backend using the user access token returned upon successful authentication. If successful, the mobile biometrics authenticator will be registered for the user that corresponds to the authorization token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mobile-biometrics-registration","name":"Register mobile biometrics","isWebhook":false,"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register mobile biometrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes mobile biometrics registration in Transmit. Before calling this API, create an authenticator (cryptographic key-pair) on the end-user's device by invoking the client-side SDK provided by Transmit. This API must be called from the backend using the user access token returned upon successful authentication. If successful, the mobile biometrics authenticator will be registered for the user that corresponds to the authorization token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsRegistrationInputDto"}},"schemaId":"components/schemas/ApiMobileBiometricsRegistrationInputDto","pointer":"/paths/~1v1~1auth~1mobile-biometrics~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/mobile-biometrics/register","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsRegistrationInputDto"}},"responseCodes":["201","400","409"],"pointer":"/v1/auth/mobile-biometrics/register","href":"other/mobile-biometrics-registration","openApiOperationId":"mobile-biometrics-registration","summary":"Register mobile biometrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiMobileBiometricsRegistrationInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsRegistrationInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The mobile biometrics authenticator has been successfully registered"},{"code":"400","description":"Invalid input. Returned when the authenticator limit has been reached, the public key type or encoding is invalid, or the attestation is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation"]}},"schemaId":"schema_333","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation"]},{"code":"409","description":"A crypto key with this public key ID is already registered","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}},"schemaId":"schema_334"}],"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1register/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"400","schemaId":"schema_333","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding","paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation"]}}},{"code":"409","schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/mobile-biometrics/register"},{"label":"Delete mobile biometrics","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-mobile-biometrics.openapi/other/mobile-biometrics-deletion","routeSlug":"/openapi/user/backend-mobile-biometrics.openapi/other/mobile-biometrics-deletion","metadata":{"seo":{"title":"Delete mobile biometrics","description":"Deletes mobile biometrics authenticator for a user that is currently logged in. This API must be called from the backend using the user access token. If successful, the key will be deleted for the user that corresponds to the authorization token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mobile-biometrics-deletion","name":"Delete mobile biometrics","isWebhook":false,"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1delete/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete mobile biometrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes mobile biometrics authenticator for a user that is currently logged in. This API must be called from the backend using the user access token. If successful, the key will be deleted for the user that corresponds to the authorization token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsDeletionInputDto"}},"schemaId":"components/schemas/ApiMobileBiometricsDeletionInputDto","pointer":"/paths/~1v1~1auth~1mobile-biometrics~1delete/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/auth/mobile-biometrics/delete","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsDeletionInputDto"}},"responseCodes":["204","400","404"],"pointer":"/v1/auth/mobile-biometrics/delete","href":"other/mobile-biometrics-deletion","openApiOperationId":"mobile-biometrics-deletion","summary":"Delete mobile biometrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiMobileBiometricsDeletionInputDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiMobileBiometricsDeletionInputDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Mobile biometrics authenticator deleted"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335"},{"code":"404","description":"Key not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound"]}},"schemaId":"schema_336","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound"]}],"pointer":"/paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}}},{"code":"404","schemaId":"schema_336","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/mobile-biometrics/delete"}],"store":{"schemaStore":{"components/schemas/ApiNativeMobileBiometricsStartWithIdentifierRequestDto":{"id":"components/schemas/ApiNativeMobileBiometricsStartWithIdentifierRequestDto","kind":"json-schema","title":"ApiNativeMobileBiometricsStartWithIdentifierRequestDto","data":{"type":"object","properties":{"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"approval_data":{"type":"object","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"},"description":"Flat object that contains the data that your customer should approve for a transaction signing or custom approval flow. It can contain up to 10 keys, and only alphanumeric characters, underscores, hyphens, and periods. It will be returned as a claim in the ID token upon successful authentication."},"timeout":{"type":"number","default":600},"identifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User identifier, which may correspond to the user's email, phone number, username, or user ID. The type of identifier should be specified as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"identifier_type":{"type":"string","description":"Type of user identifier used for login"}},"required":["identifier","identifier_type"]}},"components/schemas/ApiNativeMobileBiometricsStartWithUserIdRequestDto":{"id":"components/schemas/ApiNativeMobileBiometricsStartWithUserIdRequestDto","kind":"json-schema","title":"ApiNativeMobileBiometricsStartWithUserIdRequestDto","data":{"type":"object","properties":{"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"approval_data":{"type":"object","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"},"description":"Flat object that contains the data that your customer should approve for a transaction signing or custom approval flow. It can contain up to 10 keys, and only alphanumeric characters, underscores, hyphens, and periods. It will be returned as a claim in the ID token upon successful authentication."},"timeout":{"type":"number","default":600},"user_id":{"type":"string","description":"ID of the user","deprecated":true}},"required":["user_id"]}},"components/schemas/ApiNativeMobileBiometricsStartResponseDto":{"id":"components/schemas/ApiNativeMobileBiometricsStartResponseDto","kind":"json-schema","title":"ApiNativeMobileBiometricsStartResponseDto","data":{"type":"object","properties":{"challenge":{"type":"string"}},"required":["challenge"]}},"components/schemas/ApiNativeMobileBiometricsTokenWithIdentifierRequestDto":{"id":"components/schemas/ApiNativeMobileBiometricsTokenWithIdentifierRequestDto","kind":"json-schema","title":"ApiNativeMobileBiometricsTokenWithIdentifierRequestDto","data":{"type":"object","properties":{"resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource URI the authentication request is attempting to access, which is reflected in the audience ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim) of the access token. This must be configured as resource for the application."},"children":[]}]}]}]},"claims":{"example":{"id_token":{"roles":null}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OIDC Standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported claims and how to request custom claims, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.transmitsecurity.com/openapi/id_token_reference/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Token Reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiTokenRequestClaims"}]},"org_id":{"type":"string","description":"Organization ID, used for member login in B2B scenarios"},"client_attributes":{"description":"Client attributes","allOf":[{"$ref":"#/components/schemas/ClientAttributes"}]},"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"session_id":{"type":"string","description":"Used to associate the authentication with an existing session (such as for MFA). If unspecified, a new session is created and the session ID is returned."},"signature":{"type":"string","description":"Signed challenge returned by SDK authentication call"},"challenge":{"type":"string","description":"A string used to create attestation"},"key_id":{"type":"string","description":"ID of the key"},"identifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User identifier, which may correspond to the user's email, phone number, username, or user ID. The type of identifier should be specified as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"identifier_type":{"type":"string","description":"Type of user identifier used for login"}},"required":["signature","challenge","key_id","identifier","identifier_type"]}},"components/schemas/ApiNativeMobileBiometricsTokenWithUserIdRequestDto":{"id":"components/schemas/ApiNativeMobileBiometricsTokenWithUserIdRequestDto","kind":"json-schema","title":"ApiNativeMobileBiometricsTokenWithUserIdRequestDto","data":{"type":"object","properties":{"resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource URI the authentication request is attempting to access, which is reflected in the audience ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim) of the access token. This must be configured as resource for the application."},"children":[]}]}]}]},"claims":{"example":{"id_token":{"roles":null}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OIDC Standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported claims and how to request custom claims, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.transmitsecurity.com/openapi/id_token_reference/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Token Reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiTokenRequestClaims"}]},"org_id":{"type":"string","description":"Organization ID, used for member login in B2B scenarios"},"client_attributes":{"description":"Client attributes","allOf":[{"$ref":"#/components/schemas/ClientAttributes"}]},"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"session_id":{"type":"string","description":"Used to associate the authentication with an existing session (such as for MFA). If unspecified, a new session is created and the session ID is returned."},"signature":{"type":"string","description":"Signed challenge returned by SDK authentication call"},"challenge":{"type":"string","description":"A string used to create attestation"},"key_id":{"type":"string","description":"ID of the key"},"user_id":{"type":"string","description":"ID of the user","deprecated":true}},"required":["signature","challenge","key_id","user_id"]}},"components/schemas/ApiTokenResponse":{"id":"components/schemas/ApiTokenResponse","kind":"json-schema","title":"ApiTokenResponse","data":{"type":"object","properties":{"access_token":{"type":"string","description":"User access token for accessing endpoints on behalf of the authenticated user."},"id_token":{"type":"string","description":"ID token that identifies the user."},"refresh_token":{"type":"string","description":"Refresh token used to refresh an expired access token."},"token_type":{"type":"string","description":"Bearer."},"expires_in":{"type":"number","description":"Expiration time of the access token in seconds.","default":3600},"session_id":{"type":"string","description":"ID of the session in which the authentication occurs."},"signing_artifacts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cryptographic data required to independently verify a transaction approval outside Mosaic. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approval_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided for a supported transaction-signing flow; fields vary by authenticator."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ApiPasskeySigningArtifactsDto"},{"$ref":"#/components/schemas/ApiCryptoKeySigningArtifactsDto"}]}},"required":["access_token","token_type","expires_in","session_id"]}},"components/schemas/ApiPasskeySigningArtifactsDto":{"id":"components/schemas/ApiPasskeySigningArtifactsDto","kind":"json-schema","title":"ApiPasskeySigningArtifactsDto","data":{"type":"object","properties":{"approval_data":{"type":"object","additionalProperties":{"type":"string"},"description":"Transaction data provided when the transaction-signing flow was started. Returned after a successful approval.","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"}},"public_key":{"type":"string","description":"Public key used to verify the signature."},"signature":{"type":"string","description":"Signature generated by the passkey authenticator."},"credential_id":{"type":"string","description":"Identifier of the passkey credential used for the approval."},"webauthn_session_id":{"type":"string","description":"Identifier of the WebAuthn authentication session."},"authenticator_data":{"type":"string","description":"Base64url-encoded data returned by the passkey authenticator as part of the WebAuthn assertion."},"client_data_json":{"type":"string","description":"Base64url-encoded client data from the WebAuthn authentication response."},"raw_challenge":{"type":"string","description":"Raw pre-hash challenge used to bind the signature to the approval data."}},"required":["approval_data","public_key","signature","credential_id","webauthn_session_id","authenticator_data","client_data_json","raw_challenge"]}},"components/schemas/ApiSigningArtifactAlgorithmDto":{"id":"components/schemas/ApiSigningArtifactAlgorithmDto","kind":"json-schema","title":"ApiSigningArtifactAlgorithmDto","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature algorithm used to verify the signature, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecdsa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rsa-pss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"hash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash algorithm used to verify the signature, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sha-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"saltLength":{"type":"number","description":"Length, in bytes, of the salt used by RSA-PSS."},"namedCurve":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elliptic curve used by ECDSA, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["name"]}},"components/schemas/ApiCryptoKeySigningArtifactsDto":{"id":"components/schemas/ApiCryptoKeySigningArtifactsDto","kind":"json-schema","title":"ApiCryptoKeySigningArtifactsDto","data":{"type":"object","properties":{"approval_data":{"type":"object","additionalProperties":{"type":"string"},"description":"Transaction data provided when the transaction-signing flow was started. Returned after a successful approval.","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"}},"public_key":{"type":"string","description":"Public key used to verify the signature."},"signature":{"type":"string","description":"Signature generated for the transaction-signing challenge."},"challenge":{"type":"string","description":"Challenge used to generate the signature and bind it to the approval data."},"algorithm":{"description":"Parameters required to verify the signature.","allOf":[{"$ref":"#/components/schemas/ApiSigningArtifactAlgorithmDto"}]}},"required":["approval_data","public_key","signature","challenge","algorithm"]}},"components/schemas/ApiTokenRequestClaims":{"id":"components/schemas/ApiTokenRequestClaims","kind":"json-schema","title":"ApiTokenRequestClaims","data":{"type":"object","properties":{"id_token":{"type":"object"},"access_token":{"type":"object"}}}},"components/schemas/ClientAttributes":{"id":"components/schemas/ClientAttributes","kind":"json-schema","title":"ClientAttributes","data":{"type":"object","properties":{"user_agent":{"type":"string"},"ip_address":{"type":"string"}}}},"components/schemas/ApiMobileBiometricsRegistrationInputDto":{"id":"components/schemas/ApiMobileBiometricsRegistrationInputDto","kind":"json-schema","title":"ApiMobileBiometricsRegistrationInputDto","data":{"type":"object","properties":{"device_id":{"type":"string","description":"The device associated with this registration."},"publicKey":{"type":"string","description":"Public key generated by SDK registration call"},"publicKeyId":{"type":"string","description":"ID of the public key"},"encryptionType":{"type":"string","description":"Encryption type","enum":["rsa","ec"],"default":"rsa"},"challenge":{"type":"string","description":"A string used to create attestation"},"attestation_encoded_result":{"type":"string","description":"Encoded attestation data"},"os":{"type":"string","description":"OS type"},"displayName":{"type":"string","description":"Display name for the crypto key"}},"required":["publicKey","publicKeyId","os"]}},"components/schemas/ApiMobileBiometricsDeletionInputDto":{"id":"components/schemas/ApiMobileBiometricsDeletionInputDto","kind":"json-schema","title":"ApiMobileBiometricsDeletionInputDto","data":{"type":"object","properties":{"publicKeyId":{"type":"string","description":"ID of the public key"}},"required":["publicKeyId"]}},"schema_330":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ApiNativeMobileBiometricsStartWithIdentifierRequestDto"},{"$ref":"#/components/schemas/ApiNativeMobileBiometricsStartWithUserIdRequestDto"}]},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ApiNativeMobileBiometricsTokenWithIdentifierRequestDto"},{"$ref":"#/components/schemas/ApiNativeMobileBiometricsTokenWithUserIdRequestDto"}]},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_invalid_signature","user_not_found","session_not_found"]},"message":{"type":"string"}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":400},"ts_error_code":{"type":"string","enum":["system_invalid_input","auth_max_authenticators_count_exceeded","auth_invalid_attestation","auth_invalid_key_type","auth_invalid_key_encoding"]}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":409},"ts_error_code":{"type":"string","enum":["system_conflict"]}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":400},"ts_error_code":{"type":"string","enum":["system_invalid_input"]}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":404},"ts_error_code":{"type":"string","enum":["auth_key_not_found"]}}},"id":"schema_336"}},"exampleStore":{"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded":{"value":{"message":"Authenticator limit exceeded","error_code":400,"ts_error_code":"auth_max_authenticators_count_exceeded"},"key":"AuthenticatorLimitExceeded","summary":"AuthenticatorLimitExceeded","id":"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/AuthenticatorLimitExceeded"},"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType":{"value":{"message":"Public key type does not match the expected type","error_code":400,"ts_error_code":"auth_invalid_key_type"},"key":"InvalidKeyType","summary":"InvalidKeyType","id":"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyType"},"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding":{"value":{"message":"Public key is not encoded correctly","error_code":400,"ts_error_code":"auth_invalid_key_encoding"},"key":"InvalidKeyEncoding","summary":"InvalidKeyEncoding","id":"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidKeyEncoding"},"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation":{"value":{"message":"Attestation is invalid","error_code":400,"ts_error_code":"auth_invalid_attestation"},"key":"InvalidAttestation","summary":"InvalidAttestation","id":"paths/~1v1~1auth~1mobile-biometrics~1register/post/responses/400/content/application~1json/examples/InvalidAttestation"},"paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound":{"value":{"message":"Key not found","error_code":404,"ts_error_code":"auth_key_not_found"},"key":"KeyNotFound","summary":"KeyNotFound","id":"paths/~1v1~1auth~1mobile-biometrics~1delete/delete/responses/404/content/application~1json/examples/KeyNotFound"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","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/user/backend-mobile-biometrics.openapi.json?download"},{"url":"/_bundle/openapi/user/backend-mobile-biometrics.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Mobile Biometrics","description":"Login users with native mobile biometrics. This process relies on the device ability to leverage built-in biometric sensors. To support mobile biometrics in the app, first implement the SDK call that creates an authenticator (cryptographic key-pair) on the end-user device and then register this authenticator with Transmit. The private key remains securely stored on the device and protected by biometrics, while the public key is registered with Transmit for a given user. To authenticate, the device uses mobile biometrics to access the private key and to sign a challenge that gets verified by Transmit. Note: registration and authentication are two-step procedures that start by calling the client-side SDK provided by Transmit, and complete using these APIs."}},"baseSlug":"/openapi/user/backend-mobile-biometrics.openapi","routesMapping":{}}