{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SCAN_TO_ASSIGN_CREDENTIAL",
"error": {
"message": "<string>",
"type": "uncategorized_error"
},
"result": {
"access_method": "code",
"acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"errors": [
{
"created_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"message": "<string>"
}
],
"is_managed": true,
"warnings": [
{
"created_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"warning_code": "waiting_to_be_issued",
"new_code": "<string>",
"original_code": "<string>"
}
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"akiles_metadata": {
"member_pin_id": "<string>"
},
"assa_abloy_vostio_metadata": {
"auto_join": true,
"door_names": [
"<string>"
],
"endpoint_id": "<string>",
"key_id": "<string>",
"key_issuing_request_id": "<string>",
"override_guest_acs_entrance_ids": [
"<string>"
]
},
"card_number": "<string>",
"code": "<string>",
"ends_at": "<string>",
"external_type": "pti_card",
"external_type_display_name": "<string>",
"is_issued": true,
"is_latest_desired_state_synced_with_provider": true,
"is_multi_phone_sync_credential": true,
"is_one_time_use": true,
"issued_at": "2023-11-07T05:31:56Z",
"latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
"parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"starts_at": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visionline_metadata": {
"auto_join": true,
"card_function_type": "guest",
"card_id": "<string>",
"common_acs_entrance_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credential_id": "<string>",
"guest_acs_entrance_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_valid": true,
"joiner_acs_credential_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"status": "success"
}
}Encoders
Scan to Assign a Credential
Scans a physical card placed on the specified encoder and assigns the scanned credential to an ACS user. Provide either an acs_user_id or a user_identity_id.
POST
/
acs
/
encoders
/
scan_to_assign_credential
{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SCAN_TO_ASSIGN_CREDENTIAL",
"error": {
"message": "<string>",
"type": "uncategorized_error"
},
"result": {
"access_method": "code",
"acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"errors": [
{
"created_at": "2023-11-07T05:31:56Z",
"error_code": "<string>",
"message": "<string>"
}
],
"is_managed": true,
"warnings": [
{
"created_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"warning_code": "waiting_to_be_issued",
"new_code": "<string>",
"original_code": "<string>"
}
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"akiles_metadata": {
"member_pin_id": "<string>"
},
"assa_abloy_vostio_metadata": {
"auto_join": true,
"door_names": [
"<string>"
],
"endpoint_id": "<string>",
"key_id": "<string>",
"key_issuing_request_id": "<string>",
"override_guest_acs_entrance_ids": [
"<string>"
]
},
"card_number": "<string>",
"code": "<string>",
"ends_at": "<string>",
"external_type": "pti_card",
"external_type_display_name": "<string>",
"is_issued": true,
"is_latest_desired_state_synced_with_provider": true,
"is_multi_phone_sync_credential": true,
"is_one_time_use": true,
"issued_at": "2023-11-07T05:31:56Z",
"latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
"parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"starts_at": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"visionline_metadata": {
"auto_join": true,
"card_function_type": "guest",
"card_id": "<string>",
"common_acs_entrance_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"credential_id": "<string>",
"guest_acs_entrance_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"is_valid": true,
"joiner_acs_credential_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"status": "success"
}
}Authorizations
personal_access_tokenapi_keyclient_session_token
Body
application/json
Was this page helpful?