Authorizations
API Key authentication using Bearer token
import AIInbx from 'aiinbx';
const client = new AIInbx({
  apiKey: 'My API Key',
});
const response = await client.domains.verify('domainId');
console.log(response.domain);{
  "domain": {
    "id": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "domain": "<string>",
    "verifiedAt": "<string>",
    "status": "VERIFIED",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "<string>",
        "value": "<string>",
        "priority": 123,
        "isVerified": true,
        "verificationStatus": "verified",
        "lastCheckedAt": "<string>"
      }
    ]
  },
  "verification": {
    "verification": "Pending",
    "dkimStatus": "Pending",
    "dns": {
      "domainVerification": true,
      "spf": true,
      "mx": {
        "found": true,
        "expectedPriority": 123,
        "records": [
          {
            "exchange": "<string>",
            "priority": 123
          }
        ]
      },
      "dkim": {},
      "dmarc": {
        "present": true,
        "source": "subdomain"
      },
      "mailFrom": {
        "domain": "<string>",
        "mx": true,
        "spf": true
      }
    },
    "mxConflict": {
      "hasConflict": true,
      "conflictingRecords": [
        {
          "exchange": "<string>",
          "priority": 123
        }
      ],
      "message": "<string>"
    },
    "ready": true,
    "debug": {
      "expectedVerificationToken": "<string>",
      "actualVerificationTokens": [
        "<string>"
      ],
      "domain": "<string>",
      "verificationTokenMatch": true
    }
  }
}Run verification checks for the domain and update its stored status and DNS record verification flags.
import AIInbx from 'aiinbx';
const client = new AIInbx({
  apiKey: 'My API Key',
});
const response = await client.domains.verify('domainId');
console.log(response.domain);{
  "domain": {
    "id": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "domain": "<string>",
    "verifiedAt": "<string>",
    "status": "VERIFIED",
    "dnsRecords": [
      {
        "type": "TXT",
        "name": "<string>",
        "value": "<string>",
        "priority": 123,
        "isVerified": true,
        "verificationStatus": "verified",
        "lastCheckedAt": "<string>"
      }
    ]
  },
  "verification": {
    "verification": "Pending",
    "dkimStatus": "Pending",
    "dns": {
      "domainVerification": true,
      "spf": true,
      "mx": {
        "found": true,
        "expectedPriority": 123,
        "records": [
          {
            "exchange": "<string>",
            "priority": 123
          }
        ]
      },
      "dkim": {},
      "dmarc": {
        "present": true,
        "source": "subdomain"
      },
      "mailFrom": {
        "domain": "<string>",
        "mx": true,
        "spf": true
      }
    },
    "mxConflict": {
      "hasConflict": true,
      "conflictingRecords": [
        {
          "exchange": "<string>",
          "priority": 123
        }
      ],
      "message": "<string>"
    },
    "ready": true,
    "debug": {
      "expectedVerificationToken": "<string>",
      "actualVerificationTokens": [
        "<string>"
      ],
      "domain": "<string>",
      "verificationTokenMatch": true
    }
  }
}API Key authentication using Bearer token
Was this page helpful?