REST API Reference

Limited Namespace

The Limited namespace contains the resource with the following Methods Method Endpoint Scope Description.


Operation Method Endpoint Scope Sample Description
Verify Security Data POST limited/security/verify Limited Sample Verify Security Data
Validate Security Data POST limited/security/validate Limited Sample Validate Security Data
Confirm Security Data POST limited/security/confirm Limited Sample Confirm Security Data

Verify Security Data

Verify Security Data


Configuration Header: 
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
Configuration Query Parameters:
Request Parameters: 

			{
    
			"info":  {
        
			"type":  9
			
    },
    
			"verify_data":  {
        
			"email":  {
            
			"address":  "Stephen.Wilso@yahoo.com"
			
        }
			
    }
			
}
Response Parameters: 

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  396528,
        
			"program_id":  10895,
        
			"user_id":  0,
        
			"pos_id":  0,
        
			"type":  9,
        
			"source_id":  null,
        
			"server_date":  "2023-01-30T11:10:22",
        
			"date_utc":  "2023-01-30T08:10:22",
        
			"source_time_zone":  "UTC +00:00"
			
    },
    
			"verify_data":  {
        
			"username":  null,
        
			"email":  {
            
			"id":  0,
            
			"type":  null,
            
			"address":  "Stephen.Wilso@yahoo.com",
            
			"is_primary":  null,
            
			"status":  null,
            
			"verification_status":  null,
            
			"original_source_id":  null,
            
			"server_date":  null,
            
			"date_utc":  null,
            
			"client_date":  null,
            
			"update_date_utc":  null,
            
			"custom_field":  null
			
        },
        
			"phone":  null
			
    },
    
			"geo_coordinates":  null,
    
			"notes":  null,
    
			"last_activity":  null,
    
			"authentication":  [
        
			{
            
			"type":  9,
            
			"code":  "16923"
			
        }
			
    ],
    
			"validate":  null,
    
			"function_code":  0,
    
			"time_zone":  "UTC +00:00",
    
			"time_zone_name":  "Europe/London",
    
			"response_time":  836
			
}
×

Validate Security Data

Validate Security Data


Configuration Header: 
  • lang : en
  • source_id : SourceID
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
Configuration Query Parameters:
Request Parameters: 

			{
    
			"info":  {
        
			"id":  0,
        
			"program_id":  0,
        
			"user_id":  0,
        
			"type":  8
			
    },
    
			"validate_data":  {
        
			"email":  {
            
			"id":  0,
            
			"address":  "S.Wilson@yahoo.com"
			
        }
			
    },
    
			"function_code":  0,
    
			"time_zone":  "UTC +02:00",
    
			"time_zone_name":  "Asia/Amman",
    
			"response_time":  0
			
}
Response Parameters: 

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  0,
        
			"program_id":  10895,
        
			"user_id":  0,
        
			"type":  8,
        
			"source_id":  "e9897dc8-c2f3-4003-b0ab-336da73a9170",
        
			"server_date":  "2023-01-30T11:12:39",
        
			"date_utc":  "2023-01-30T08:12:39",
        
			"source_time_zone":  "UTC +00:00"
			
    },
    
			"validate_data":  {
        
			"email":  {
            
			"id":  0,
            
			"type":  null,
            
			"address":  "S.Wilson@yahoo.com",
            
			"is_primary":  null,
            
			"status":  null,
            
			"verification_status":  null,
            
			"original_source_id":  null,
            
			"server_date":  null,
            
			"date_utc":  null,
            
			"client_date":  null,
            
			"update_date_utc":  null,
            
			"custom_field":  null
			
        },
        
			"phone":  null
			
    },
    
			"geo_coordinates":  null,
    
			"notes":  null,
    
			"last_activity":  null,
    
			"authentication":  null,
    
			"validate":  null,
    
			"function_code":  0,
    
			"time_zone":  "UTC +00:00",
    
			"time_zone_name":  "Europe/London",
    
			"response_time":  125
			
}
×

Confirm Security Data

Confirm Security Data


Configuration Header: 
  • lang : en
  • source_id : {{$guid}}
  • time_zone : UTC +02:00
  • show_sensitive_data : 1
Configuration Query Parameters:
Request Parameters: 

			{
    
			"info":  {
        
			"type":  9
			
    },
    
			"verify_data":  {
        
			"email":  {
            
			"address":  "Stephen.Wilso@yahoo.com"
			
        }
			
    },
    
			"confirm_data":  {
        
			"verification_code":  "361147"
			
    }
			
}
Response Parameters: 

			{
    
			"result":  {
        
			"code":  "0000",
        
			"message":  "Operation Completed Successfully.",
        
			"friendly_message":  "Operation Completed Successfully."
			
    },
    
			"info":  {
        
			"id":  0,
        
			"program_id":  10895,
        
			"user_id":  0,
        
			"type":  9,
        
			"source_id":  null,
        
			"server_date":  "2023-01-30T11:14:57",
        
			"date_utc":  "2023-01-30T08:14:57",
        
			"source_time_zone":  "UTC +00:00"
			
    },
    
			"verify_data":  {
        
			"username":  null,
        
			"email":  {
            
			"id":  0,
            
			"type":  null,
            
			"address":  "Stephen.Wilso@yahoo.com",
            
			"is_primary":  null,
            
			"status":  null,
            
			"verification_status":  null,
            
			"original_source_id":  null,
            
			"server_date":  null,
            
			"date_utc":  null,
            
			"client_date":  null,
            
			"update_date_utc":  null,
            
			"custom_field":  null
			
        },
        
			"phone":  null
			
    },
    
			"confirm_data":  {
        
			"verification_code":  "361147"
			
    },
    
			"geo_coordinates":  null,
    
			"notes":  null,
    
			"last_activity":  null,
    
			"authentication":  null,
    
			"validate":  null,
    
			"function_code":  0,
    
			"time_zone":  "UTC +00:00",
    
			"time_zone_name":  "Europe/London",
    
			"response_time":  303
			
}
×