User API
Overview¶
Retrieves the user information associated with the specified JUID.
- Base URL:
https://{dev-server}/v1 - Path GET:
/user/{juid}
URL Path Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| juid | string | Yes | Unique ID of the resource |
Authentication¶
This API uses OAuth 2.0 for authentication and authorization. All requests must include a valid OAuth access token in the Authorization header as a Bearer token. Access is restricted based on the permissions granted to the authenticated user or application.
HTTP Headers¶
Content Type: application/json
Accept: application/json
Authorization: Bearer YOUR_API_TOKEN
traceId: 123
Response¶
{
"firstname": "Joe",
"lastname": "James",
"dob": "2000-01-01",
"juid": "JUID123456",
"account": {
"status": "Active",
"balance": 10000
},
"address": {
"streetNumber": "3",
"streetName": "K-street",
"town": "Kuilsriver",
"city": "Cape Town",
"province": "Western Cape",
"postalCode": "7896"
}
}
Error Responses¶
| Status Code | Error Message | Description |
|---|---|---|
| 401 | Unauhotized | Client not authorized to access this service. |
| 400 | Invalid input | The request data is invalid. |
| 500 | Internal server error | An unexpected server error occurred. |