Create User Auth Context Update Request
POST /obp/v7.0.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD
OBPv5.0.0-createUserAuthContextUpdateRequest No role required User
Create User Auth Context Update Request. User Authentication is Required. The User must be logged in. The Application must also be authenticated.
A User uses this to prove that they are a Customer of the bank BANK_ID, for example by naming their CUSTOMER_NUMBER. A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the Customer's own contact details, via the transport defined in SCA_METHOD, and the User then answers it with Answer User Auth Context Update Challenge. SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
Because this sends a message to a Customer of the bank, the request must come either from an App (Consumer) that has the Scope CanCreateUserAuthContextUpdate at BANK_ID, or from a User that has the Role CanCreateUserAuthContextUpdate at BANK_ID. Either one is enough. A Scope is granted with Create Scope for a Consumer (POST /consumers/CONSUMER_ID/scopes).
URL Parameters:
BANK_ID: gh.29.uk
SCA_METHOD:
JSON response body fields (6)
Example request body
{
"key": "CUSTOMER_NUMBER",
"value": "78987432"
}Example success response
{
"user_auth_context_update_id": "613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"key": "CUSTOMER_NUMBER",
"value": "78987432",
"status": "INITIATED",
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}Possible errors (6)
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-20023: Consumer is missing one or more roles:
- OBP-30053: Could not insert the UserAuthContext
- OBP-50000: Unknown Error.