Retrieves the details of a real-name verified registrant.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Ensures the idempotency of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. Note
If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request. |
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| RegistrantId |
string |
Yes |
The ID of the real-name verified registrant. |
2072277378616354816 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The unique request ID. |
B57C121B-A45F-44D8-A9B2-13E5A5044195 |
| RegistrantId |
string |
The ID of the real-name verified registrant. |
2072277378616354816 |
| Name |
string |
The name of the registrant. The name can be up to 255 characters in length. |
Zhang xx |
| DocumentType |
string |
The document type of the registrant. For more information, see the appendix on document types. |
SFZ |
| DocumentCode |
string |
The document number of the registrant. The number can be up to 50 characters in length. |
110123456789122341 |
|
string |
The email address. The address can be up to 300 characters in length. |
example@example.com |
|
| Cc |
string |
The country. |
China |
| State |
string |
The state or province. |
Zhejiang |
| City |
string |
The city. Default value: Hangzhou. |
Hangzhou |
| Street |
string |
The street address. |
xx District, xx Street |
| Phone |
string |
The phone number of the registrant. The number can be up to 128 characters in length. If the country is China and the number is not a mobile phone number, the area code must match the city. |
13112345678 |
| Status |
string |
The real-name verification status. Valid values:
|
Approved |
| RejectReason |
string |
The reason why the real-name verification was rejected. |
Subject to the actual response |
| CreateTimestamp |
string |
The creation time (UNIX timestamp). |
1533773400000 |
| UpdateTimestamp |
string |
The update time (UNIX timestamp). |
1527690629357 |
| AccessDeniedDetail |
object |
The details of the access denial. This field is returned only when RAM authentication fails. |
|
| AuthAction |
string |
The unauthorized operation that was attempted. |
RemoveRspDomainServerHoldStatusForGatewayOte |
| AuthPrincipalDisplayName |
string |
The display name of the authorization principal. |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
The owner ID of the authorization principal. |
10469733312XXX |
| AuthPrincipalType |
string |
The identity type. |
SubUser |
| EncodedDiagnosticMessage |
string |
The encrypted complete diagnostic message. |
AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng== |
| NoPermissionType |
string |
The reason for the authentication failure. Valid values:
|
ImplicitDeny |
| PolicyType |
string |
The policy type. |
DlpSend |
Examples
Success response
JSON format
{
"RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
"RegistrantId": "2072277378616354816",
"Name": "张xx",
"DocumentType": "SFZ",
"DocumentCode": "110123456789122341",
"Email": "example@example.com",
"Cc": "中国",
"State": "浙江省",
"City": "杭州市",
"Street": "xx区xx街道",
"Phone": "13112345678",
"Status": "Approved",
"RejectReason": "以实际返回为准",
"CreateTimestamp": "1533773400000",
"UpdateTimestamp": "1527690629357",
"AccessDeniedDetail": {
"AuthAction": "RemoveRspDomainServerHoldStatusForGatewayOte",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.