V1
Consent Information
API related with the consent information.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer ‘token’ |
| body | body | ConsentInfoRetrieveStatusRequestBody | true | ‘none’ |
Request body - instance of ConsentInfoRetrieveStatusRequestBody
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneNumber | PhoneNumber | true | A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ‘+’. |
| scopes | ConsentInfoScopes | true | List of requested scopes. |
| purpose | ConsentInfoPurpose | true | The reason for which personal data will be processed by the API Consumer. CAMARA uses the W3C Data Privacy Vocabulary (DPV) to represent these purposes e.g. dpv:FraudPreventionAndDetection or dpv:RequestedServiceProvision. |
| requestCaptureUrl | boolean | true | A boolean flag indicating whether the API Consumer requests API Provider to return a Consent capture URL. |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ConsentInfoRetrieveStatusResponseBody |
| 400 | Bad Request | Problem with the client request | ErrorInfo |
| 401 | Unauthorized | Unauthorized | ErrorInfo |
| 403 | Forbidden | Forbidden | ErrorInfo |
| 422 | Unprocessable Entity | Unprocessable Content | ErrorInfo |
| 500 | Internal Server Error | Server error | ErrorInfo |
| 503 | Service Unavailable | Service unavailable. Typically the server is down. | ErrorInfo |
| 504 | Gateway Time-out | Request time exceeded. If it happens repeatedly, consider reducing the request complexity | ErrorInfo |
Endpoints
Phone number verify
Sim Swap
Device Swap
KYC Match
Consent Information
Authentication