# #8 Phone Info

## #8.1 Add New Phone:

This API is to add client's phone number. Client can add up to 5 numbers.

## POST /Onboarding/api/v1/onboarding/PhoneInfo

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"SendPhoneInfoOtpDto":{"type":"object","required":["code","phoneNumber"],"properties":{"code":{"type":"string","nullable":false,"description":"Country Code"},"phoneNumber":{"type":"string","nullable":false,"description":"Client mobile number"}},"additionalProperties":false},"SuccessStatusStatusResultDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SuccessStatus"}},"additionalProperties":false},"SuccessStatus":{"type":"integer","format":"int32","description":"Indicates the result of the operation. 0 = Success, 1 = Failed.","enum":[0,1]},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo":{"post":{"tags":["PhoneInfo"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendPhoneInfoOtpDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessStatusStatusResultDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```

## #8.2 Send OTP :

This API is to send OTP to added mobile number. OTP will be expired after 10 minutes. 

## POST /Onboarding/api/v1/onboarding/PhoneInfo/SendOtp

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"SuccessStatusStatusResultDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SuccessStatus"}},"additionalProperties":false},"SuccessStatus":{"type":"integer","format":"int32","description":"Indicates the result of the operation. 0 = Success, 1 = Failed.","enum":[0,1]},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo/SendOtp":{"post":{"tags":["PhoneInfo"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessStatusStatusResultDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```

## #8.3 Validate OTP:

This API is to validate OTP sent to client's mobile.

## POST /Onboarding/api/v1/onboarding/PhoneInfo/ValidateOTP

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"ValidatePhoneNumberOtpDto":{"type":"object","required":["otp"],"properties":{"otp":{"type":"string","nullable":false,"description":"OTP sent to client's mobile."}},"additionalProperties":false},"SuccessStatusStatusResultDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SuccessStatus"}},"additionalProperties":false},"SuccessStatus":{"type":"integer","format":"int32","description":"Indicates the result of the operation. 0 = Success, 1 = Failed.","enum":[0,1]},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo/ValidateOTP":{"post":{"tags":["PhoneInfo"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidatePhoneNumberOtpDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessStatusStatusResultDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```

## #8.4 Get Verified Phones : 

This API is to get list of client's verified mobile numbers. 

## GET /Onboarding/api/v1/onboarding/PhoneInfo/GetVerifiedPhones

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"PhoneInfoDto":{"type":"object","required":["phoneNumber","isDefault"],"properties":{"phoneNumber":{"type":"string","nullable":false,"description":"Client's mobile number."},"isDefault":{"type":"boolean","description":"True if mobile number is default."}},"additionalProperties":false},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo/GetVerifiedPhones":{"get":{"tags":["PhoneInfo"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneInfoDto"}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```

## #8.5 Set Default Phone: 

This API is to set default client's specific mobile number if client has multiple numbers.

## POST /Onboarding/api/v1/onboarding/PhoneInfo/SetDefault

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"MakePhoneDefaultDto":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","nullable":false,"description":"Client's phone number"}},"additionalProperties":false},"SuccessStatusStatusResultDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SuccessStatus"}},"additionalProperties":false},"SuccessStatus":{"type":"integer","format":"int32","description":"Indicates the result of the operation. 0 = Success, 1 = Failed.","enum":[0,1]},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo/SetDefault":{"post":{"tags":["PhoneInfo"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MakePhoneDefaultDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessStatusStatusResultDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```

## #8.6 Finalize Phone Step:

This API is to finalize phone step. 

## POST /Onboarding/api/v1/onboarding/PhoneInfo/Approve

>

```json
{"openapi":"3.0.1","info":{"title":"eKYC Onboarding APIs (Local Env.)","version":"1.0"},"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","description":"Please insert JWT with Bearer into field","name":"Authorization","in":"header"}},"schemas":{"SuccessStatusStatusResultDto":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/SuccessStatus"}},"additionalProperties":false},"SuccessStatus":{"type":"integer","format":"int32","description":"Indicates the result of the operation. 0 = Success, 1 = Failed.","enum":[0,1]},"CustomException":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Error description message"},"errorCode":{"type":"string","nullable":true,"description":"Error Code"}},"additionalProperties":false}}},"paths":{"/Onboarding/api/v1/onboarding/PhoneInfo/Approve":{"post":{"tags":["PhoneInfo"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessStatusStatusResultDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomException"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lumin-soft.gitbook.io/ekyc/integration-throw-api/onboarding-api/8-phone-info.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.