Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/organizations/authInfos |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Contact.Org.Read-Read permission for basic information of Contacts organization |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Get it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of the authorized organization for a third-party app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| targetCorpId | String | No | The organization ID (corpId) of the organization whose authentication information you want to get. For details, see Basic concepts - CorpId. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| orgName | String | The name of the organization in DingTalk Contacts. |
| licenseOrgName | String | The organization name on the business license submitted during organization authentication. |
| registrationNum | String | The business license registration number (usually 15 digits). |
| unifiedSocialCredit | String | The unified social credit code (fixed at 18 digits). |
| organizationCode | String | The organization code certificate number (format: 11111111-1). |
| legalPerson | String | The legal representative. |
| licenseUrl | String | The URL of the business license. |
| authLevel | Long | The authentication level. Valid values: - 0: No authentication. Only the authLevel and orgName fields are returned. - 1: Premium authentication. - 2: Intermediate authentication. |
Response body example
Error codes
If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | invalidParameter.system.param | Invalid organization targetCorpId | Thrown when the organization to query does not exist. |
| 400 | permission.denied | No permission to get the organization authentication information | Thrown when the organization has not granted authorization to the custom app. |
| 400 | invalidParameter.system.param | System parameter is empty | Returned when a system parameter is empty. |
| 400 | invalidParameter.appKey.blank | appKey is empty | The appKey of the custom app is empty. |
| 500 | service.system.error | System error | Thrown when a call to a dependent service fails. |