Factors

factors_credentials_id_factor_factor_type_unenrol

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id required	integer <int64>
factor_type required	string

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

204

Success - No Content

400

Invalid Request

409

Conflict

default

Error

post/factors/{credentials_id}/factor/{factor_type}/unenrol

Response samples

400
409
default

application/json

{"message": "string",
"validation": {"invalid": true,
"fields": [{"name": "string",
"errors": [{"type": "REQUIRED",
"params": ["string"
]
}
]
}
]
}
}

factors_credentials_id_challenges_challenge_id_verify_success

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id required	integer <int64>
challenge_id required	integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_success

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_challenge_id_verify_invalid

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id required	integer <int64>
challenge_id required	integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_invalid

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_challenge_id_verify_expired

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id required	integer <int64>
challenge_id required	integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/verify_expired

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_challenge_id_get

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id required	integer <int64>
challenge_id required	integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/{challenge_id}/get

Response samples

200
400
default

application/json

{"payload": "string"
}

factors_credentials_id_challenges_latest_verify_success

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/latest/verify_success

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_latest_verify_invalid

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/latest/verify_invalid

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_latest_verify_expired

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/latest/verify_expired

Response samples

200
400
default

application/json

{"code": "COMPLETED"
}

factors_credentials_id_challenges_latest_get

SecurityAuth_Token and API_Secret_Key

Request

path Parameters

credentials_id

required

integer <int64>

header Parameters

call-ref

string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses

200

Success

400

Invalid Request

default

Error

post/factors/{credentials_id}/challenges/latest/get

Response samples

200
400
default

application/json

{"payload": "string"
}

➔ Next to Authy