{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-apis/platform/iam/sidebars.yaml","oas-apis/platform/iam/openapi/iam-openapi.json":"oas-apis/platform/iam/openapi/iam-openapi.json"},"props":{"metadata":{"markdoc":{"tagList":["openapi-code-sample","admonition"]},"type":"markdown"},"seo":{"title":"Domains","keywords":"documentation, api, portal, banking, payment, account information, aritma, psd2, open banking, reconciliation","description":"Developer documentation for Aritma's banking and financial APIs - payments, account information, webhooks, authentication and integrations.","meta":[{"name":"google-site-verification","content":"hplqlK_5O42BZjNnjtVQMEpxv9JkxcD1eH4J1T-NQmI"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"domains","__idx":0},"children":["Domains"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Domain verification lets you prove ownership of an email domain so you can create users directly within your tenant — without sending invitation emails. Once a domain is verified, any user with a matching email address can be created via the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/platform/iam/guides/user-management#create-a-user-directly"},"children":["Create user"]}," endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":1},"children":["How it works"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Register your domain in Aritma IAM — you receive a DNS TXT verification token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Publish the token as a DNS TXT record at your domain registrar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Aritma checks for the record and marks the domain as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Confirmed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can now create users directly for email addresses on that domain"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-verified-domains","__idx":2},"children":["List verified domains"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"GetDomains","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"register-a-domain-for-verification","__idx":3},"children":["Register a domain for verification"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"RegisterDomain","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["verificationToken"]}," — a DNS TXT record value you must publish at your domain registrar:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"domain\": \"example.com\",\n  \"status\": \"Pending\",\n  \"verificationToken\": \"aritma-verify-00000000-0000-0000-0000-000000000000\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a TXT record to your DNS with the value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["verificationToken"]},". The record name is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@"]}," (root) or a subdomain specified by your registrar."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"DNS propagation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DNS changes can take up to 48 hours to propagate. The verification token is removed from the response once the domain is confirmed."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-domain-status","__idx":4},"children":["Check domain status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll this endpoint to check whether verification has completed:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"GetDomain","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pending"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The domain is registered but the DNS TXT record has not been verified yet"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Confirmed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The domain is verified — you can now create users directly"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotRegistered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The domain is not registered on this tenant"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"unregister-a-domain","__idx":5},"children":["Unregister a domain"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-apis/platform/iam/openapi/iam-openapi.json","operationId":"UnregisterDomain","language":"curl","parameters":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unregistering a domain does not affect existing users. However, you will no longer be able to create new users directly for email addresses on that domain until you re-register and re-verify it."]}]}]},"headings":[{"value":"Domains","id":"domains","depth":1},{"value":"How it works","id":"how-it-works","depth":2},{"value":"List verified domains","id":"list-verified-domains","depth":2},{"value":"Register a domain for verification","id":"register-a-domain-for-verification","depth":2},{"value":"Check domain status","id":"check-domain-status","depth":2},{"value":"Unregister a domain","id":"unregister-a-domain","depth":2}],"frontmatter":{"title":"Domains","seo":{"title":"Domains"}},"lastModified":"2026-05-08T13:38:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/platform/iam/guides/domains","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}