> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/registry/registry/developer-zone/api-documentation/staff-portal-api.md).

# Staff Portal API

APIs used by the Staff Portal UI

## POST /registry-config/create\_registry\_configuration

> Create Registry Configuration

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/registry-config/create_registry_configuration":{"post":{"tags":["/registry-config"],"summary":"Create Registry Configuration","operationId":"create_registry_configuration_registry_config_create_registry_configuration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegistryConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryConfigurationDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"CreateRegistryConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/CreateRegistryConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"CreateRegistryConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"CreateRegistryConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/CreateRegistryConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"CreateRegistryConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"CreateRegistryConfigurationRequestPayload":{"properties":{"registry_name":{"type":"string","title":"Registry Name"},"registry_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Logo"}},"type":"object","required":["registry_name"],"title":"CreateRegistryConfigurationRequestPayload"},"RegistryConfigurationDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegistryConfigurationDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegistryConfigurationDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationData"},{"type":"null"}]}},"type":"object","title":"RegistryConfigurationDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegistryConfigurationData":{"properties":{"configuration_id":{"type":"string","title":"Configuration Id"},"registry_name":{"type":"string","title":"Registry Name"},"registry_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Logo"}},"type":"object","required":["configuration_id","registry_name"],"title":"RegistryConfigurationData","description":"Data for registry configuration"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /registry-config/get\_registry\_configuration

> Get Registry Configuration

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/registry-config/get_registry_configuration":{"post":{"tags":["/registry-config"],"summary":"Get Registry Configuration","operationId":"get_registry_configuration_registry_config_get_registry_configuration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegistryConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryConfigurationDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegistryConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegistryConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegistryConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegistryConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegistryConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"RegistryConfigurationDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegistryConfigurationDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegistryConfigurationDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationData"},{"type":"null"}]}},"type":"object","title":"RegistryConfigurationDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegistryConfigurationData":{"properties":{"configuration_id":{"type":"string","title":"Configuration Id"},"registry_name":{"type":"string","title":"Registry Name"},"registry_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Logo"}},"type":"object","required":["configuration_id","registry_name"],"title":"RegistryConfigurationData","description":"Data for registry configuration"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /registry-config/update\_registry\_configuration

> Update Registry Configuration

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/registry-config/update_registry_configuration":{"post":{"tags":["/registry-config"],"summary":"Update Registry Configuration","operationId":"update_registry_configuration_registry_config_update_registry_configuration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegistryConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryConfigurationDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateRegistryConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateRegistryConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateRegistryConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateRegistryConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateRegistryConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateRegistryConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateRegistryConfigurationRequestPayload":{"properties":{"configuration_id":{"type":"string","title":"Configuration Id"},"registry_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Name"},"registry_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Logo"}},"type":"object","required":["configuration_id"],"title":"UpdateRegistryConfigurationRequestPayload"},"RegistryConfigurationDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegistryConfigurationDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegistryConfigurationDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegistryConfigurationData"},{"type":"null"}]}},"type":"object","title":"RegistryConfigurationDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegistryConfigurationData":{"properties":{"configuration_id":{"type":"string","title":"Configuration Id"},"registry_name":{"type":"string","title":"Registry Name"},"registry_logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Logo"}},"type":"object","required":["configuration_id","registry_name"],"title":"RegistryConfigurationData","description":"Data for registry configuration"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /registry-config/get\_number\_of\_requests\_pending

> Get Number Of Requests Pending

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/registry-config/get_number_of_requests_pending":{"post":{"tags":["/registry-config"],"summary":"Get Number Of Requests Pending","operationId":"get_number_of_requests_pending_registry_config_get_number_of_requests_pending_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNumberOfRequestsPendingRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberOfRequestsPendingResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetNumberOfRequestsPendingRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetNumberOfRequestsPendingRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetNumberOfRequestsPendingRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetNumberOfRequestsPendingRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetNumberOfRequestsPendingRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"NumberOfRequestsPendingResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/NumberOfRequestsPendingResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"NumberOfRequestsPendingResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"NumberOfRequestsPendingResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/NumberOfRequestsPendingData"},{"type":"null"}]}},"type":"object","title":"NumberOfRequestsPendingResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"NumberOfRequestsPendingData":{"properties":{"number_of_requests_pending":{"type":"integer","title":"Number Of Requests Pending"}},"type":"object","required":["number_of_requests_pending"],"title":"NumberOfRequestsPendingData","description":"Data for get_number_of_requests_pending endpoint"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /registry-config/get\_earliest\_pending\_change\_request

> Get Earliest Pending Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/registry-config/get_earliest_pending_change_request":{"post":{"tags":["/registry-config"],"summary":"Get Earliest Pending Change Request","operationId":"get_earliest_pending_change_request_registry_config_get_earliest_pending_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEarliestPendingChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarliestPendingChangeRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetEarliestPendingChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetEarliestPendingChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetEarliestPendingChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetEarliestPendingChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetEarliestPendingChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"EarliestPendingChangeRequestResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/EarliestPendingChangeRequestResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"EarliestPendingChangeRequestResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"EarliestPendingChangeRequestResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/EarliestPendingChangeRequestData"},{"type":"null"}]}},"type":"object","title":"EarliestPendingChangeRequestResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"EarliestPendingChangeRequestData":{"properties":{"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"source_partner_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Partner Id"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done"},"approval_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Status"},"change_payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Change Payload"}},"type":"object","title":"EarliestPendingChangeRequestData","description":"Data for get_earliest_pending_change_request endpoint"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Create Register

> Create a new register definition and null register schema record.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/create_register":{"post":{"tags":["/register-metadata"],"summary":"Create Register","description":"Create a new register definition and null register schema record.","operationId":"create_register_register_metadata_create_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"CreateRegisterRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/CreateRegisterRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"CreateRegisterRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"CreateRegisterRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/CreateRegisterRequestPayload"}},"type":"object","required":["request_payload"],"title":"CreateRegisterRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"CreateRegisterRequestPayload":{"properties":{"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"dedup_is_enabled":{"type":"boolean","title":"Dedup Is Enabled","default":false},"dedup_threshold_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dedup Threshold Score"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"}},"type":"object","required":["register_mnemonic"],"title":"CreateRegisterRequestPayload"},"RegisterDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterData"},{"type":"null"}]}},"type":"object","title":"RegisterDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"}},"type":"object","required":["register_id","register_mnemonic"],"title":"RegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Edit Register

> Edit an existing register definition.\
> If the register has data, only mnemonic and description can be edited.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/edit_register":{"post":{"tags":["/register-metadata"],"summary":"Edit Register","description":"Edit an existing register definition.\nIf the register has data, only mnemonic and description can be edited.","operationId":"edit_register_register_metadata_edit_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"EditRegisterRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/EditRegisterRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"EditRegisterRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"EditRegisterRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EditRegisterRequestPayload"}},"type":"object","required":["request_payload"],"title":"EditRegisterRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EditRegisterRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Mnemonic"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"dedup_is_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dedup Is Enabled"},"dedup_threshold_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dedup Threshold Score"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"}},"type":"object","required":["register_id"],"title":"EditRegisterRequestPayload"},"RegisterDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterData"},{"type":"null"}]}},"type":"object","title":"RegisterDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"}},"type":"object","required":["register_id","register_mnemonic"],"title":"RegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Delete Register

> Delete a register definition if it has no data.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/delete_register":{"post":{"tags":["/register-metadata"],"summary":"Delete Register","description":"Delete a register definition if it has no data.","operationId":"delete_register_register_metadata_delete_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"DeleteRegisterRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/DeleteRegisterRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"DeleteRegisterRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"DeleteRegisterRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/DeleteRegisterRequestPayload"}},"type":"object","required":["request_payload"],"title":"DeleteRegisterRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"DeleteRegisterRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"DeleteRegisterRequestPayload"},"RegisterDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterData"},{"type":"null"}]}},"type":"object","title":"RegisterDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"}},"type":"object","required":["register_id","register_mnemonic"],"title":"RegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-metadata/get\_all\_registers

> Get All Registers

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_all_registers":{"post":{"tags":["/register-metadata"],"summary":"Get All Registers","operationId":"get_all_registers_register_metadata_get_all_registers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllRegistersRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllRegistersResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetAllRegistersRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetAllRegistersRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetAllRegistersRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetAllRegistersRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetAllRegistersRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"AllRegistersResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/AllRegistersResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"AllRegistersResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"AllRegistersResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/AllRegistersRegisterData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"AllRegistersResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"AllRegistersRegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"},"master_register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Mnemonic"},"has_data":{"type":"boolean","title":"Has Data","default":false},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"program_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Mnemonic"},"has_image":{"type":"boolean","title":"Has Image","default":false},"dedup_is_enabled":{"type":"boolean","title":"Dedup Is Enabled","default":false},"dedup_threshold_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dedup Threshold Score"}},"type":"object","required":["register_id","register_mnemonic"],"title":"AllRegistersRegisterData","description":"Extended RegisterData for get_all_registers API with additional fields"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Dashboard Registers

> Get all registers for dashboard display (clone of get\_all\_registers)

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_dashboard_registers":{"post":{"tags":["/register-metadata"],"summary":"Get Dashboard Registers","description":"Get all registers for dashboard display (clone of get_all_registers)","operationId":"get_dashboard_registers_register_metadata_get_dashboard_registers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDashboardRegistersRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRegistersResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetDashboardRegistersRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetDashboardRegistersRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetDashboardRegistersRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetDashboardRegistersRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetDashboardRegistersRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"DashboardRegistersResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/DashboardRegistersResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"DashboardRegistersResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"DashboardRegistersResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"DashboardRegistersResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"}},"type":"object","required":["register_id","register_mnemonic"],"title":"RegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-metadata/get\_child\_registers

> Get Child Registers

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_child_registers":{"post":{"tags":["/register-metadata"],"summary":"Get Child Registers","operationId":"get_child_registers_register_metadata_get_child_registers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChildRegistersRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChildRegistersResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetChildRegistersRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetChildRegistersRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetChildRegistersRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetChildRegistersRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetChildRegistersRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetChildRegistersRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetChildRegistersRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"GetChildRegistersRequestPayload"},"ChildRegistersResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChildRegistersResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChildRegistersResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChildRegistersResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChildRegisterData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"ChildRegistersResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChildRegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"}},"type":"object","required":["register_id","register_mnemonic"],"title":"ChildRegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-metadata/get\_master\_register

> Get Master Register

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_master_register":{"post":{"tags":["/register-metadata"],"summary":"Get Master Register","operationId":"get_master_register_register_metadata_get_master_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMasterRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetMasterRegisterRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetMasterRegisterRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetMasterRegisterRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetMasterRegisterRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetMasterRegisterRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetMasterRegisterRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetMasterRegisterRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"GetMasterRegisterRequestPayload"},"RegisterDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterData"},{"type":"null"}]}},"type":"object","title":"RegisterDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"register_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Description"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"register_rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Register Rank"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"}},"type":"object","required":["register_id","register_mnemonic"],"title":"RegisterData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Register Schema

> Get register schema configuration for a given register\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_register_schema":{"post":{"tags":["/register-metadata"],"summary":"Get Register Schema","description":"Get register schema configuration for a given register_id.","operationId":"get_register_schema_register_metadata_get_register_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterSchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterSchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterSchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterSchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterSchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterSchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterSchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterSchemaRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"GetRegisterSchemaRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Register Schema

> Update an existing register schema configuration for a given register\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_register_schema":{"post":{"tags":["/register-metadata"],"summary":"Update Register Schema","description":"Update an existing register schema configuration for a given register_id.","operationId":"update_register_schema_register_metadata_update_register_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegisterSchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateRegisterSchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateRegisterSchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateRegisterSchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateRegisterSchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateRegisterSchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateRegisterSchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateRegisterSchemaRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"UpdateRegisterSchemaRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Dedup Is Enabled

> Update the dedup\_is\_enabled flag for a register.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_dedup_is_enabled":{"post":{"tags":["/register-metadata"],"summary":"Update Dedup Is Enabled","description":"Update the dedup_is_enabled flag for a register.","operationId":"update_dedup_is_enabled_register_metadata_update_dedup_is_enabled_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDedupIsEnabledRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateDedupIsEnabledRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateDedupIsEnabledRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateDedupIsEnabledRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateDedupIsEnabledRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateDedupIsEnabledRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateDedupIsEnabledRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateDedupIsEnabledRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"dedup_is_enabled":{"type":"boolean","title":"Dedup Is Enabled"}},"type":"object","required":["register_id","dedup_is_enabled"],"title":"UpdateDedupIsEnabledRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Dedup Threshold Score

> Update the dedup\_threshold\_score for a register.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_dedup_threshold_score":{"post":{"tags":["/register-metadata"],"summary":"Update Dedup Threshold Score","description":"Update the dedup_threshold_score for a register.","operationId":"update_dedup_threshold_score_register_metadata_update_dedup_threshold_score_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDedupThresholdScoreRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateDedupThresholdScoreRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateDedupThresholdScoreRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateDedupThresholdScoreRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateDedupThresholdScoreRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateDedupThresholdScoreRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateDedupThresholdScoreRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateDedupThresholdScoreRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"dedup_threshold_score":{"type":"number","title":"Dedup Threshold Score"}},"type":"object","required":["register_id","dedup_threshold_score"],"title":"UpdateDedupThresholdScoreRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Deduplication Schema

> Update the deduplicate\_schema for a register.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_deduplication_schema":{"post":{"tags":["/register-metadata"],"summary":"Update Deduplication Schema","description":"Update the deduplicate_schema for a register.","operationId":"update_deduplication_schema_register_metadata_update_deduplication_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeduplicationSchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateDeduplicationSchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateDeduplicationSchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateDeduplicationSchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateDeduplicationSchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateDeduplicationSchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateDeduplicationSchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateDeduplicationSchemaRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Deduplicate Schema"}},"type":"object","required":["register_id","deduplicate_schema"],"title":"UpdateDeduplicationSchemaRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Search Result Schema

> Update the search\_result\_schema for a register.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_search_result_schema":{"post":{"tags":["/register-metadata"],"summary":"Update Search Result Schema","description":"Update the search_result_schema for a register.","operationId":"update_search_result_schema_register_metadata_update_search_result_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSearchResultSchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateSearchResultSchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateSearchResultSchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateSearchResultSchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateSearchResultSchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateSearchResultSchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateSearchResultSchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateSearchResultSchemaRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"search_result_schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Search Result Schema"}},"type":"object","required":["register_id","search_result_schema"],"title":"UpdateSearchResultSchemaRequestPayload"},"RegisterSchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSchemaData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"deduplicate_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Deduplicate Schema"},"search_result_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Search Result Schema"},"filter_schema":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Filter Schema"}},"type":"object","required":["register_id"],"title":"RegisterSchemaData","description":"Schema data for a register including deduplication, search result, and filter configurations."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Register Sections

> Get all sections for a given register\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_register_sections":{"post":{"tags":["/register-metadata"],"summary":"Get Register Sections","description":"Get all sections for a given register_id.","operationId":"get_register_sections_register_metadata_get_register_sections_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterSectionsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterSectionsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterSectionsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterSectionsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterSectionsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterSectionsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterSectionsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterSectionsRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"GetRegisterSectionsRequestPayload"},"RegisterSectionsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterSectionData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"RegisterSectionsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Register Tab Sections

> Get all sections for a given register\_id and tab\_id with pagination.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_register_tab_sections":{"post":{"tags":["/register-metadata"],"summary":"Get Register Tab Sections","description":"Get all sections for a given register_id and tab_id with pagination.","operationId":"get_register_tab_sections_register_metadata_get_register_tab_sections_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterTabSectionsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterTabSectionsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterTabSectionsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterTabSectionsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterTabSectionsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterTabSectionsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterTabSectionsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterTabSectionsRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["register_id","tab_id"],"title":"GetRegisterTabSectionsRequestPayload"},"RegisterSectionsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterSectionData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"RegisterSectionsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Add Register Section

> Add a new section for a given register\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/add_register_section":{"post":{"tags":["/register-metadata"],"summary":"Add Register Section","description":"Add a new section for a given register_id.","operationId":"add_register_section_register_metadata_add_register_section_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRegisterSectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"AddRegisterSectionRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/AddRegisterSectionRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"AddRegisterSectionRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"AddRegisterSectionRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/AddRegisterSectionRequestPayload"}},"type":"object","required":["request_payload"],"title":"AddRegisterSectionRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"AddRegisterSectionRequestPayload":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"}},"type":"object","required":["section_register_id","register_id","tab_id","section_mnemonic"],"title":"AddRegisterSectionRequestPayload"},"RegisterSectionDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Delete Register Section

> Delete a section by section\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/delete_register_section":{"post":{"tags":["/register-metadata"],"summary":"Delete Register Section","description":"Delete a section by section_id.","operationId":"delete_register_section_register_metadata_delete_register_section_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRegisterSectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"DeleteRegisterSectionRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/DeleteRegisterSectionRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"DeleteRegisterSectionRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"DeleteRegisterSectionRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/DeleteRegisterSectionRequestPayload"}},"type":"object","required":["request_payload"],"title":"DeleteRegisterSectionRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"DeleteRegisterSectionRequestPayload":{"properties":{"section_id":{"type":"string","title":"Section Id"}},"type":"object","required":["section_id"],"title":"DeleteRegisterSectionRequestPayload"},"RegisterSectionDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Register Section

> Update a section's metadata (not including UI schema).

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_register_section":{"post":{"tags":["/register-metadata"],"summary":"Update Register Section","description":"Update a section's metadata (not including UI schema).","operationId":"update_register_section_register_metadata_update_register_section_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegisterSectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateRegisterSectionRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateRegisterSectionRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateRegisterSectionRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateRegisterSectionRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateRegisterSectionRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateRegisterSectionRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateRegisterSectionRequestPayload":{"properties":{"section_id":{"type":"string","title":"Section Id"},"section_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"documents_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Documents Required"},"auto_approval":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Approval"},"cr_auto_approve_for_bene_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cr Auto Approve For Bene Portal"},"cr_auto_approve_for_agent_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cr Auto Approve For Agent Portal"},"cr_auto_approve_for_staff_portal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cr Auto Approve For Staff Portal"},"cr_auto_approve_for_partner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cr Auto Approve For Partner"},"cr_auto_approve_for_intake_form":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cr Auto Approve For Intake Form"},"is_primary_section":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Primary Section"}},"type":"object","required":["section_id"],"title":"UpdateRegisterSectionRequestPayload","description":"Only allows editing: section_mnemonic, section_description, no_of_verifications_required,\ndocuments_required, auto_approval, cr_auto_approve_for_*, is_primary_section"},"RegisterSectionDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Update Register Section Ui Schema

> Update a section's UI schema.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/update_register_section_ui_schema":{"post":{"tags":["/register-metadata"],"summary":"Update Register Section Ui Schema","description":"Update a section's UI schema.","operationId":"update_register_section_ui_schema_register_metadata_update_register_section_ui_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegisterSectionUISchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"UpdateRegisterSectionUISchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/UpdateRegisterSectionUISchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"UpdateRegisterSectionUISchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"UpdateRegisterSectionUISchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/UpdateRegisterSectionUISchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"UpdateRegisterSectionUISchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"UpdateRegisterSectionUISchemaRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"}},"type":"object","required":["register_id","section_id"],"title":"UpdateRegisterSectionUISchemaRequestPayload"},"RegisterSectionDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Register Section Ui Schema

> Get UI schema for a specific section.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_register_section_ui_schema":{"post":{"tags":["/register-metadata"],"summary":"Get Register Section Ui Schema","description":"Get UI schema for a specific section.","operationId":"get_register_section_ui_schema_register_metadata_get_register_section_ui_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterSectionUISchemaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionUISchemaDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterSectionUISchemaRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterSectionUISchemaRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterSectionUISchemaRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterSectionUISchemaRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterSectionUISchemaRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterSectionUISchemaRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterSectionUISchemaRequestPayload":{"properties":{"section_id":{"type":"string","title":"Section Id"}},"type":"object","required":["section_id"],"title":"GetRegisterSectionUISchemaRequestPayload"},"RegisterSectionUISchemaDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionUISchemaDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionUISchemaDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionUISchemaDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionUISchemaData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionUISchemaDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionUISchemaData":{"properties":{"section_id":{"type":"string","title":"Section Id"},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"}},"type":"object","required":["section_id"],"title":"RegisterSectionUISchemaData","description":"UI schema data for a register section."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Register Tabs

> Get all UI tabs for a given register\_id with pagination.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/get_register_tabs":{"post":{"tags":["/register-metadata"],"summary":"Get Register Tabs","description":"Get all UI tabs for a given register_id with pagination.","operationId":"get_register_tabs_register_metadata_get_register_tabs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterTabsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTabsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterTabsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterTabsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterTabsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterTabsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterTabsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterTabsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterTabsRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"used_for_new_intake_form":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used For New Intake Form"}},"type":"object","required":["register_id"],"title":"GetRegisterTabsRequestPayload"},"RegisterTabsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterTabsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterTabsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterTabsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterUITabData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"RegisterTabsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterUITabData":{"properties":{"tab_id":{"type":"string","title":"Tab Id"},"register_id":{"type":"string","title":"Register Id"},"tab_label":{"type":"string","title":"Tab Label"},"tab_order":{"type":"integer","title":"Tab Order"},"used_for_new_intake_form":{"type":"boolean","title":"Used For New Intake Form","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"type":"boolean","title":"Intake Form Auto Approve","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true}},"type":"object","required":["tab_id","register_id","tab_label","tab_order"],"title":"RegisterUITabData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Add Register Tab

> Add a new UI tab for a given register\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/add_register_tab":{"post":{"tags":["/register-metadata"],"summary":"Add Register Tab","description":"Add a new UI tab for a given register_id.","operationId":"add_register_tab_register_metadata_add_register_tab_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRegisterTabRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTabDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"AddRegisterTabRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/AddRegisterTabRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"AddRegisterTabRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"AddRegisterTabRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/AddRegisterTabRequestPayload"}},"type":"object","required":["request_payload"],"title":"AddRegisterTabRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"AddRegisterTabRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"tab_label":{"type":"string","title":"Tab Label"},"tab_order":{"type":"integer","title":"Tab Order","default":0},"used_for_new_intake_form":{"type":"boolean","title":"Used For New Intake Form","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"type":"boolean","title":"Intake Form Auto Approve","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true}},"type":"object","required":["register_id","tab_label"],"title":"AddRegisterTabRequestPayload"},"RegisterTabDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterTabDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterTabDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterTabDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterUITabData"},{"type":"null"}]}},"type":"object","title":"RegisterTabDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterUITabData":{"properties":{"tab_id":{"type":"string","title":"Tab Id"},"register_id":{"type":"string","title":"Register Id"},"tab_label":{"type":"string","title":"Tab Label"},"tab_order":{"type":"integer","title":"Tab Order"},"used_for_new_intake_form":{"type":"boolean","title":"Used For New Intake Form","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"type":"boolean","title":"Intake Form Auto Approve","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true}},"type":"object","required":["tab_id","register_id","tab_label","tab_order"],"title":"RegisterUITabData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Delete Register Tab

> Delete a UI tab by tab\_id.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/delete_register_tab":{"post":{"tags":["/register-metadata"],"summary":"Delete Register Tab","description":"Delete a UI tab by tab_id.","operationId":"delete_register_tab_register_metadata_delete_register_tab_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRegisterTabRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTabDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"DeleteRegisterTabRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/DeleteRegisterTabRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"DeleteRegisterTabRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"DeleteRegisterTabRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/DeleteRegisterTabRequestPayload"}},"type":"object","required":["request_payload"],"title":"DeleteRegisterTabRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"DeleteRegisterTabRequestPayload":{"properties":{"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["tab_id"],"title":"DeleteRegisterTabRequestPayload"},"RegisterTabDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterTabDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterTabDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterTabDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterUITabData"},{"type":"null"}]}},"type":"object","title":"RegisterTabDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterUITabData":{"properties":{"tab_id":{"type":"string","title":"Tab Id"},"register_id":{"type":"string","title":"Register Id"},"tab_label":{"type":"string","title":"Tab Label"},"tab_order":{"type":"integer","title":"Tab Order"},"used_for_new_intake_form":{"type":"boolean","title":"Used For New Intake Form","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"type":"boolean","title":"Intake Form Auto Approve","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true}},"type":"object","required":["tab_id","register_id","tab_label","tab_order"],"title":"RegisterUITabData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Edit Register Tab

> Edit an existing UI tab.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-metadata/edit_register_tab":{"post":{"tags":["/register-metadata"],"summary":"Edit Register Tab","description":"Edit an existing UI tab.","operationId":"edit_register_tab_register_metadata_edit_register_tab_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRegisterTabRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTabDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"EditRegisterTabRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/EditRegisterTabRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"EditRegisterTabRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"EditRegisterTabRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EditRegisterTabRequestPayload"}},"type":"object","required":["request_payload"],"title":"EditRegisterTabRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EditRegisterTabRequestPayload":{"properties":{"tab_id":{"type":"string","title":"Tab Id"},"tab_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Label"},"tab_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tab Order"},"used_for_new_intake_form":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Used For New Intake Form"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Intake Form Auto Approve"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","required":["tab_id"],"title":"EditRegisterTabRequestPayload"},"RegisterTabDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterTabDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterTabDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterTabDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterUITabData"},{"type":"null"}]}},"type":"object","title":"RegisterTabDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterUITabData":{"properties":{"tab_id":{"type":"string","title":"Tab Id"},"register_id":{"type":"string","title":"Register Id"},"tab_label":{"type":"string","title":"Tab Label"},"tab_order":{"type":"integer","title":"Tab Order"},"used_for_new_intake_form":{"type":"boolean","title":"Used For New Intake Form","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"intake_form_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Name"},"intake_form_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intake Form Description"},"intake_form_auto_approve":{"type":"boolean","title":"Intake Form Auto Approve","default":false},"is_active":{"type":"boolean","title":"Is Active","default":true}},"type":"object","required":["tab_id","register_id","tab_label","tab_order"],"title":"RegisterUITabData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /vc-config/get\_vc\_configuration\_for\_register

> Get Vc Configuration For Register

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/vc-config/get_vc_configuration_for_register":{"post":{"tags":["/vc-config"],"summary":"Get Vc Configuration For Register","operationId":"get_vc_configuration_for_register_vc_config_get_vc_configuration_for_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"VcConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/VcConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"VcConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"VcConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/VcConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"VcConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"VcConfigurationRequestPayload":{"properties":{"vc_config_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Config Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"vc_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Mnemonic"},"descriptor_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Descriptor Schema"}},"type":"object","title":"VcConfigurationRequestPayload"},"VcConfigurationResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VcConfigurationResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VcConfigurationResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VcConfigurationResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VcConfigurationData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"VcConfigurationResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VcConfigurationData":{"properties":{"vc_config_id":{"type":"string","title":"Vc Config Id"},"register_id":{"type":"string","title":"Register Id"},"vc_mnemonic":{"type":"string","title":"Vc Mnemonic"},"descriptor_schema":{"additionalProperties":true,"type":"object","title":"Descriptor Schema"}},"type":"object","required":["vc_config_id","register_id","vc_mnemonic","descriptor_schema"],"title":"VcConfigurationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /vc-config/get\_all\_vc\_configurations

> Get All Vc Configurations

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/vc-config/get_all_vc_configurations":{"post":{"tags":["/vc-config"],"summary":"Get All Vc Configurations","operationId":"get_all_vc_configurations_vc_config_get_all_vc_configurations_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"VcConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/VcConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"VcConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"VcConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/VcConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"VcConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"VcConfigurationRequestPayload":{"properties":{"vc_config_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Config Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"vc_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Mnemonic"},"descriptor_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Descriptor Schema"}},"type":"object","title":"VcConfigurationRequestPayload"},"VcConfigurationResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VcConfigurationResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VcConfigurationResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VcConfigurationResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VcConfigurationData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"VcConfigurationResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VcConfigurationData":{"properties":{"vc_config_id":{"type":"string","title":"Vc Config Id"},"register_id":{"type":"string","title":"Register Id"},"vc_mnemonic":{"type":"string","title":"Vc Mnemonic"},"descriptor_schema":{"additionalProperties":true,"type":"object","title":"Descriptor Schema"}},"type":"object","required":["vc_config_id","register_id","vc_mnemonic","descriptor_schema"],"title":"VcConfigurationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /vc-config/create\_vc\_configuration

> Create Vc Configuration

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/vc-config/create_vc_configuration":{"post":{"tags":["/vc-config"],"summary":"Create Vc Configuration","operationId":"create_vc_configuration_vc_config_create_vc_configuration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"VcConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/VcConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"VcConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"VcConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/VcConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"VcConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"VcConfigurationRequestPayload":{"properties":{"vc_config_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Config Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"vc_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Mnemonic"},"descriptor_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Descriptor Schema"}},"type":"object","title":"VcConfigurationRequestPayload"},"VcConfigurationResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VcConfigurationResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VcConfigurationResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VcConfigurationResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VcConfigurationData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"VcConfigurationResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VcConfigurationData":{"properties":{"vc_config_id":{"type":"string","title":"Vc Config Id"},"register_id":{"type":"string","title":"Register Id"},"vc_mnemonic":{"type":"string","title":"Vc Mnemonic"},"descriptor_schema":{"additionalProperties":true,"type":"object","title":"Descriptor Schema"}},"type":"object","required":["vc_config_id","register_id","vc_mnemonic","descriptor_schema"],"title":"VcConfigurationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /vc-config/edit\_descriptor\_schema

> Edit Descriptor Schema

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/vc-config/edit_descriptor_schema":{"post":{"tags":["/vc-config"],"summary":"Edit Descriptor Schema","operationId":"edit_descriptor_schema_vc_config_edit_descriptor_schema_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"VcConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/VcConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"VcConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"VcConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/VcConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"VcConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"VcConfigurationRequestPayload":{"properties":{"vc_config_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Config Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"vc_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Mnemonic"},"descriptor_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Descriptor Schema"}},"type":"object","title":"VcConfigurationRequestPayload"},"VcConfigurationResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VcConfigurationResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VcConfigurationResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VcConfigurationResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VcConfigurationData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"VcConfigurationResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VcConfigurationData":{"properties":{"vc_config_id":{"type":"string","title":"Vc Config Id"},"register_id":{"type":"string","title":"Register Id"},"vc_mnemonic":{"type":"string","title":"Vc Mnemonic"},"descriptor_schema":{"additionalProperties":true,"type":"object","title":"Descriptor Schema"}},"type":"object","required":["vc_config_id","register_id","vc_mnemonic","descriptor_schema"],"title":"VcConfigurationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /vc-config/remove\_vc\_configuration

> Remove Vc Configuration

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/vc-config/remove_vc_configuration":{"post":{"tags":["/vc-config"],"summary":"Remove Vc Configuration","operationId":"remove_vc_configuration_vc_config_remove_vc_configuration_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VcConfigurationResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"VcConfigurationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/VcConfigurationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"VcConfigurationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"VcConfigurationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/VcConfigurationRequestPayload"}},"type":"object","required":["request_payload"],"title":"VcConfigurationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"VcConfigurationRequestPayload":{"properties":{"vc_config_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Config Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"vc_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vc Mnemonic"},"descriptor_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Descriptor Schema"}},"type":"object","title":"VcConfigurationRequestPayload"},"VcConfigurationResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VcConfigurationResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VcConfigurationResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VcConfigurationResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VcConfigurationData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"VcConfigurationResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VcConfigurationData":{"properties":{"vc_config_id":{"type":"string","title":"Vc Config Id"},"register_id":{"type":"string","title":"Register Id"},"vc_mnemonic":{"type":"string","title":"Vc Mnemonic"},"descriptor_schema":{"additionalProperties":true,"type":"object","title":"Descriptor Schema"}},"type":"object","required":["vc_config_id","register_id","vc_mnemonic","descriptor_schema"],"title":"VcConfigurationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-data/get\_number\_of\_versions

> Get Number Of Versions

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_number_of_versions":{"post":{"tags":["/register-data"],"summary":"Get Number Of Versions","operationId":"get_number_of_versions_register_data_get_number_of_versions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNumberOfVersionsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberOfVersionsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetNumberOfVersionsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetNumberOfVersionsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetNumberOfVersionsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetNumberOfVersionsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetNumberOfVersionsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetNumberOfVersionsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetNumberOfVersionsRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["register_id","internal_record_id","tab_id"],"title":"GetNumberOfVersionsRequestPayload"},"NumberOfVersionsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/NumberOfVersionsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"NumberOfVersionsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"NumberOfVersionsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/NumberOfVersionsData"},{"type":"null"}]}},"type":"object","title":"NumberOfVersionsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"NumberOfVersionsData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"number_of_versions":{"type":"integer","title":"Number Of Versions"},"last_updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated By"},"last_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated At"},"last_approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Approved By"},"last_approved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Approved At"}},"type":"object","required":["register_id","internal_record_id","tab_id","number_of_versions"],"title":"NumberOfVersionsData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Record History

> Get the history records for a given register, internal\_record\_id and tab\_id.\
> Returns all historical versions of the record, ordered by approved\_at descending.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_record_history":{"post":{"tags":["/register-data"],"summary":"Get Record History","description":"Get the history records for a given register, internal_record_id and tab_id.\nReturns all historical versions of the record, ordered by approved_at descending.","operationId":"get_record_history_register_data_get_record_history_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRecordHistoryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordHistoryDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRecordHistoryRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRecordHistoryRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRecordHistoryRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRecordHistoryRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRecordHistoryRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRecordHistoryRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRecordHistoryRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["register_id","internal_record_id","tab_id"],"title":"GetRecordHistoryRequestPayload"},"RecordHistoryDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RecordHistoryDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RecordHistoryDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RecordHistoryDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RecordHistoryListData"},{"type":"null"}]}},"type":"object","title":"RecordHistoryDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RecordHistoryListData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"history_records":{"items":{"$ref":"#/components/schemas/RecordHistoryData"},"type":"array","title":"History Records","default":[]}},"type":"object","required":["register_id","internal_record_id","tab_id"],"title":"RecordHistoryListData","description":"Container for a list of history records with metadata"},"RecordHistoryData":{"properties":{"history_record_id":{"type":"string","title":"History Record Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"change_request_id":{"type":"string","title":"Change Request Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_id":{"type":"string","title":"Section Id"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"change_request_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Source"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"additionalProperties":true,"type":"object","required":["history_record_id","internal_record_id","change_request_id","tab_id","section_id"],"title":"RecordHistoryData","description":"History record data with flattened additional fields.\nExtra fields from the register history implementation table are included at root level."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Version Dates

> Get unique truncated dates from history records for a given register, internal\_record\_id and tab\_id.\
> Returns a list of unique dates (YYYY-MM-DD format) based on created\_at of history records.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_version_dates":{"post":{"tags":["/register-data"],"summary":"Get Version Dates","description":"Get unique truncated dates from history records for a given register, internal_record_id and tab_id.\nReturns a list of unique dates (YYYY-MM-DD format) based on created_at of history records.","operationId":"get_version_dates_register_data_get_version_dates_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVersionDatesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionDatesDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetVersionDatesRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetVersionDatesRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetVersionDatesRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetVersionDatesRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetVersionDatesRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetVersionDatesRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetVersionDatesRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["register_id","internal_record_id","tab_id"],"title":"GetVersionDatesRequestPayload"},"VersionDatesDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VersionDatesDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VersionDatesDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VersionDatesDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/VersionDatesData"},{"type":"null"}]}},"type":"object","title":"VersionDatesDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VersionDatesData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"version_dates":{"items":{"type":"string"},"type":"array","title":"Version Dates","default":[]}},"type":"object","required":["register_id","internal_record_id","tab_id"],"title":"VersionDatesData","description":"Container for a list of unique version dates"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Versions For A Date

> Get changes from history records for a given register, internal\_record\_id, tab\_id and specific date.\
> Returns a list of change\_request\_id, section\_id, section\_mnemonic, and created\_at.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_versions_for_a_date":{"post":{"tags":["/register-data"],"summary":"Get Versions For A Date","description":"Get changes from history records for a given register, internal_record_id, tab_id and specific date.\nReturns a list of change_request_id, section_id, section_mnemonic, and created_at.","operationId":"get_versions_for_a_date_register_data_get_versions_for_a_date_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangesForDateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangesForDateDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetChangesForDateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetChangesForDateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetChangesForDateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetChangesForDateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetChangesForDateRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetChangesForDateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetChangesForDateRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"truncated_created_date":{"type":"string","title":"Truncated Created Date"}},"type":"object","required":["register_id","internal_record_id","tab_id","truncated_created_date"],"title":"GetChangesForDateRequestPayload"},"ChangesForDateDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangesForDateDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangesForDateDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangesForDateDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/VersionsForDateData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"ChangesForDateDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VersionsForDateData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"truncated_created_date":{"type":"string","title":"Truncated Created Date"},"section_id":{"type":"string","title":"Section Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"changes":{"items":{"$ref":"#/components/schemas/VersionForDateData"},"type":"array","title":"Changes","default":[]}},"type":"object","required":["register_id","internal_record_id","tab_id","truncated_created_date","section_id","section_mnemonic"],"title":"VersionsForDateData","description":"Container for changes for a specific section and date"},"VersionForDateData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["change_request_id","created_at"],"title":"VersionForDateData","description":"Individual change record for a specific date"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-data/get\_subject\_record

> Get Subject Record

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_subject_record":{"post":{"tags":["/register-data"],"summary":"Get Subject Record","operationId":"get_subject_record_register_data_get_subject_record_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSubjectRecordRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetSubjectRecordRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetSubjectRecordRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetSubjectRecordRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetSubjectRecordRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetSubjectRecordRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetSubjectRecordRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetSubjectRecordRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"}},"type":"object","required":["subject_register_id","subject_record_id"],"title":"GetSubjectRecordRequestPayload"},"RecordDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RecordDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RecordDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RecordDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RecordData"},{"type":"null"}]}},"type":"object","title":"RecordDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RecordData":{"properties":{},"additionalProperties":true,"type":"object","title":"RecordData","description":"Record data with flattened additional fields.\nExtra fields from the register implementation table are included at root level."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Deduplication Register Results

> Get deduplication results for a change request against register records.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_deduplication_register_results":{"post":{"tags":["/register-data"],"summary":"Get Deduplication Register Results","description":"Get deduplication results for a change request against register records.","operationId":"get_deduplication_register_results_register_data_get_deduplication_register_results_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeduplicationRegisterResultsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeduplicationRegisterResultsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetDeduplicationRegisterResultsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetDeduplicationRegisterResultsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetDeduplicationRegisterResultsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetDeduplicationRegisterResultsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetDeduplicationRegisterResultsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetDeduplicationRegisterResultsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetDeduplicationRegisterResultsRequestPayload":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"}},"type":"object","required":["change_request_id"],"title":"GetDeduplicationRegisterResultsRequestPayload"},"DeduplicationRegisterResultsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/DeduplicationRegisterResultsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"DeduplicationRegisterResultsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"DeduplicationRegisterResultsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/DeduplicationRegisterResultsData"},{"type":"null"}]}},"type":"object","title":"DeduplicationRegisterResultsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"DeduplicationRegisterResultsData":{"properties":{"results":{"items":{"$ref":"#/components/schemas/DeduplicationRegisterResultData"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"DeduplicationRegisterResultsData","description":"List of deduplication results for a change request against register records."},"DeduplicationRegisterResultData":{"properties":{"dedup_result_id":{"type":"string","title":"Dedup Result Id"},"change_request_id":{"type":"string","title":"Change Request Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"match_score":{"type":"number","title":"Match Score"},"field_matches":{"additionalProperties":true,"type":"object","title":"Field Matches"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["dedup_result_id","change_request_id","internal_record_id","match_score","field_matches"],"title":"DeduplicationRegisterResultData","description":"Deduplication result for a change request against a register record."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Deduplication Change Request Results

> Get deduplication results for a change request against other change requests.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_deduplication_change_request_results":{"post":{"tags":["/register-data"],"summary":"Get Deduplication Change Request Results","description":"Get deduplication results for a change request against other change requests.","operationId":"get_deduplication_change_request_results_register_data_get_deduplication_change_request_results_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeduplicationChangerequestResultsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeduplicationChangerequestResultsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetDeduplicationChangerequestResultsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetDeduplicationChangerequestResultsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetDeduplicationChangerequestResultsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetDeduplicationChangerequestResultsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetDeduplicationChangerequestResultsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetDeduplicationChangerequestResultsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetDeduplicationChangerequestResultsRequestPayload":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"}},"type":"object","required":["change_request_id"],"title":"GetDeduplicationChangerequestResultsRequestPayload"},"DeduplicationChangerequestResultsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/DeduplicationChangerequestResultsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"DeduplicationChangerequestResultsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"DeduplicationChangerequestResultsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/DeduplicationChangerequestResultsData"},{"type":"null"}]}},"type":"object","title":"DeduplicationChangerequestResultsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"DeduplicationChangerequestResultsData":{"properties":{"results":{"items":{"$ref":"#/components/schemas/DeduplicationChangerequestResultData"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"DeduplicationChangerequestResultsData","description":"List of deduplication results for a change request against other change requests."},"DeduplicationChangerequestResultData":{"properties":{"dedup_result_id":{"type":"string","title":"Dedup Result Id"},"change_request_id":{"type":"string","title":"Change Request Id"},"candidate_change_request_id":{"type":"string","title":"Candidate Change Request Id"},"match_score":{"type":"number","title":"Match Score"},"field_matches":{"additionalProperties":true,"type":"object","title":"Field Matches"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["dedup_result_id","change_request_id","candidate_change_request_id","match_score","field_matches"],"title":"DeduplicationChangerequestResultData","description":"Deduplication result for a change request against another change request."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Schema Definition For Register Section

> Get schema definition for a specific section of a register.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_schema_definition_for_register_section":{"post":{"tags":["/register-data"],"summary":"Get Schema Definition For Register Section","description":"Get schema definition for a specific section of a register.","operationId":"get_schema_definition_for_register_section_register_data_get_schema_definition_for_register_section_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterSectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSectionDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterSectionRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterSectionRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterSectionRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterSectionRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterSectionRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterSectionRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterSectionRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"}},"type":"object","required":["register_id","section_id"],"title":"GetRegisterSectionRequestPayload"},"RegisterSectionDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSectionDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSectionDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/RegisterSectionData"},{"type":"null"}]}},"type":"object","title":"RegisterSectionDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Section Records

> Get records from a section register that are linked to a subject record.\
> Traverses the master-child hierarchy between registers.\
> If subject\_register\_id == section\_register\_id, returns the subject record directly.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_section_records":{"post":{"tags":["/register-data"],"summary":"Get Section Records","description":"Get records from a section register that are linked to a subject record.\nTraverses the master-child hierarchy between registers.\nIf subject_register_id == section_register_id, returns the subject record directly.","operationId":"get_section_records_register_data_get_section_records_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSectionRecordsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionRecordsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetSectionRecordsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetSectionRecordsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetSectionRecordsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetSectionRecordsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetSectionRecordsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetSectionRecordsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetSectionRecordsRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"section_register_id":{"type":"string","title":"Section Register Id"}},"type":"object","required":["subject_register_id","subject_record_id","section_register_id"],"title":"GetSectionRecordsRequestPayload"},"SectionRecordsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/SectionRecordsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"SectionRecordsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"SectionRecordsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RecordData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"SectionRecordsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RecordData":{"properties":{},"additionalProperties":true,"type":"object","title":"RecordData","description":"Record data with flattened additional fields.\nExtra fields from the register implementation table are included at root level."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Tab Records

> Get all records for a tab, grouped by unique section\_register\_id.\
> Multiple sections with the same section\_register\_id are deduplicated.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_tab_records":{"post":{"tags":["/register-data"],"summary":"Get Tab Records","description":"Get all records for a tab, grouped by unique section_register_id.\nMultiple sections with the same section_register_id are deduplicated.","operationId":"get_tab_records_register_data_get_tab_records_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterTabRecordsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterTabRecordsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterTabRecordsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterTabRecordsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterTabRecordsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterTabRecordsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetRegisterTabRecordsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterTabRecordsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetRegisterTabRecordsRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["subject_register_id","subject_record_id","tab_id"],"title":"GetRegisterTabRecordsRequestPayload"},"RegisterTabRecordsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterTabRecordsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterTabRecordsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterTabRecordsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterTabRecordData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"RegisterTabRecordsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterTabRecordData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"is_list":{"type":"boolean","title":"Is List","default":false},"records":{"items":{"$ref":"#/components/schemas/RecordData"},"type":"array","title":"Records"}},"type":"object","required":["section_register_id","records"],"title":"RegisterTabRecordData","description":"Records for a single section_register_id within a tab.\nMultiple sections with the same section_register_id are deduplicated."},"RecordData":{"properties":{},"additionalProperties":true,"type":"object","title":"RecordData","description":"Record data with flattened additional fields.\nExtra fields from the register implementation table are included at root level."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-data/get\_register\_summary\_data

> Get Register Summary Data

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_register_summary_data":{"post":{"tags":["/register-data"],"summary":"Get Register Summary Data","operationId":"get_register_summary_data_register_data_get_register_summary_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRegisterSummaryDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSummaryDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetRegisterSummaryDataRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetRegisterSummaryDataRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetRegisterSummaryDataRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetRegisterSummaryDataRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetRegisterSummaryDataRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"RegisterSummaryDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/RegisterSummaryDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"RegisterSummaryDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"RegisterSummaryDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterSummaryData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"RegisterSummaryDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSummaryData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"register_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Subject"},"has_image":{"type":"boolean","title":"Has Image"},"register_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Icon"},"total_record_count":{"type":"integer","title":"Total Record Count"}},"type":"object","required":["register_id","register_mnemonic","has_image","total_record_count"],"title":"RegisterSummaryData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /register-data/search\_in\_a\_register

> Search In A Register

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/search_in_a_register":{"post":{"tags":["/register-data"],"summary":"Search In A Register","operationId":"search_in_a_register_register_data_search_in_a_register_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRegisterRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"SearchRegisterRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/SearchRegisterRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"SearchRegisterRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"SearchRegisterRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/SearchRegisterRequestPayload"}},"type":"object","required":["request_payload"],"title":"SearchRegisterRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"SearchRegisterRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"SearchRegisterRequestPayload"},"SearchResultsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/SearchResultsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"SearchResultsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"SearchResultsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/SearchResultData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"SearchResultsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"SearchResultData":{"properties":{"internal_record_id":{"type":"string","title":"Internal Record Id"},"functional_record_id":{"type":"string","title":"Functional Record Id"},"link_internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Internal Record Id"},"foundational_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foundational Id"},"link_foundational_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Foundational Id"},"record_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Name"},"record_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Image Url"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"last_approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Approved At"},"last_approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Approved By"},"display_fields":{"anyOf":[{"items":{"$ref":"#/components/schemas/DisplayField"},"type":"array"},{"type":"null"}],"title":"Display Fields"}},"type":"object","required":["internal_record_id","functional_record_id"],"title":"SearchResultData"},"DisplayField":{"properties":{"field_name":{"type":"string","title":"Field Name"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"order":{"type":"integer","title":"Order"}},"type":"object","required":["field_name","order"],"title":"DisplayField"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Allowed Parents For A Child Section

> Get allowed parent records for a child section.\
> Given a subject record and a child section register, finds the parent register\
> of that section and returns all records from the parent register that are linked\
> to the subject.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/register-data/get_allowed_parents_for_a_child_section":{"post":{"tags":["/register-data"],"summary":"Get Allowed Parents For A Child Section","description":"Get allowed parent records for a child section.\nGiven a subject record and a child section register, finds the parent register\nof that section and returns all records from the parent register that are linked\nto the subject.","operationId":"get_allowed_parents_for_a_child_section_register_data_get_allowed_parents_for_a_child_section_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllowedParentsForChildSectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllowedParentsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetAllowedParentsForChildSectionRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetAllowedParentsForChildSectionRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetAllowedParentsForChildSectionRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetAllowedParentsForChildSectionRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetAllowedParentsForChildSectionRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetAllowedParentsForChildSectionRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetAllowedParentsForChildSectionRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"section_register_id":{"type":"string","title":"Section Register Id"}},"type":"object","required":["subject_register_id","internal_record_id","section_register_id"],"title":"GetAllowedParentsForChildSectionRequestPayload"},"AllowedParentsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/AllowedParentsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"AllowedParentsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"AllowedParentsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/AllowedParentsData"},{"type":"null"}]}},"type":"object","title":"AllowedParentsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"AllowedParentsData":{"properties":{"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"master_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Master Register Id"},"allowed_parents":{"items":{"$ref":"#/components/schemas/AllowedParentRecordData"},"type":"array","title":"Allowed Parents"}},"type":"object","required":["register_mnemonic","allowed_parents"],"title":"AllowedParentsData"},"AllowedParentRecordData":{"properties":{"internal_record_id":{"type":"string","title":"Internal Record Id"},"record_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Record Name"}},"type":"object","required":["internal_record_id"],"title":"AllowedParentRecordData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/create\_change\_request

> Create Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/create_change_request":{"post":{"tags":["/change-requests"],"summary":"Create Change Request","operationId":"create_change_request_change_requests_create_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"ChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/ChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"ChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"ChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/ChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"ChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"ChangeRequestRequestPayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Mnemonic"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"change_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangePayload"},"type":"array"},{"type":"null"}],"title":"Change Payload"},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangeRequestDocumentPayload"},"type":"array"},{"type":"null"}],"title":"Documents"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"rejection_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Reason"}},"type":"object","title":"ChangeRequestRequestPayload","description":"Request payload for creating/updating change requests - sent from Partners"},"ChangePayload":{"properties":{"internal_record_id":{"type":"string","title":"Internal Record Id"},"edit_action":{"$ref":"#/components/schemas/EditActionEnum"}},"additionalProperties":true,"type":"object","required":["internal_record_id","edit_action"],"title":"ChangePayload"},"EditActionEnum":{"type":"string","enum":["ADD","UPDATE","DELETE","NO_CHANGE"],"title":"EditActionEnum"},"ChangeRequestDocumentPayload":{"properties":{"document_label":{"type":"string","title":"Document Label"},"document_store_id":{"type":"string","title":"Document Store Id"}},"type":"object","required":["document_label","document_store_id"],"title":"ChangeRequestDocumentPayload","description":"Document reference to attach to a change request"},"ChangeRequestResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponsePayload"},{"type":"null"}]}},"type":"object","title":"ChangeRequestResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestResponsePayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required","default":0},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done","default":0},"approval_status":{"$ref":"#/components/schemas/ApprovalStatusEnum","default":"PENDING"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"type":"object","title":"ChangeRequestResponsePayload","description":"Response payload for change requests - returned to clients"},"ApprovalStatusEnum":{"type":"string","enum":["PENDING","APPROVED","REJECTED"],"title":"ApprovalStatusEnum"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/approve\_change\_request

> Approve Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/approve_change_request":{"post":{"tags":["/change-requests"],"summary":"Approve Change Request","operationId":"approve_change_request_change_requests_approve_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"ChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/ChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"ChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"ChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/ChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"ChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"ChangeRequestRequestPayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Mnemonic"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"change_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangePayload"},"type":"array"},{"type":"null"}],"title":"Change Payload"},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangeRequestDocumentPayload"},"type":"array"},{"type":"null"}],"title":"Documents"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"rejection_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Reason"}},"type":"object","title":"ChangeRequestRequestPayload","description":"Request payload for creating/updating change requests - sent from Partners"},"ChangePayload":{"properties":{"internal_record_id":{"type":"string","title":"Internal Record Id"},"edit_action":{"$ref":"#/components/schemas/EditActionEnum"}},"additionalProperties":true,"type":"object","required":["internal_record_id","edit_action"],"title":"ChangePayload"},"EditActionEnum":{"type":"string","enum":["ADD","UPDATE","DELETE","NO_CHANGE"],"title":"EditActionEnum"},"ChangeRequestDocumentPayload":{"properties":{"document_label":{"type":"string","title":"Document Label"},"document_store_id":{"type":"string","title":"Document Store Id"}},"type":"object","required":["document_label","document_store_id"],"title":"ChangeRequestDocumentPayload","description":"Document reference to attach to a change request"},"ChangeRequestResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponsePayload"},{"type":"null"}]}},"type":"object","title":"ChangeRequestResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestResponsePayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required","default":0},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done","default":0},"approval_status":{"$ref":"#/components/schemas/ApprovalStatusEnum","default":"PENDING"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"type":"object","title":"ChangeRequestResponsePayload","description":"Response payload for change requests - returned to clients"},"ApprovalStatusEnum":{"type":"string","enum":["PENDING","APPROVED","REJECTED"],"title":"ApprovalStatusEnum"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/reject\_change\_request

> Reject Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/reject_change_request":{"post":{"tags":["/change-requests"],"summary":"Reject Change Request","operationId":"reject_change_request_change_requests_reject_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"ChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/ChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"ChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"ChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/ChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"ChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"ChangeRequestRequestPayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Mnemonic"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"change_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangePayload"},"type":"array"},{"type":"null"}],"title":"Change Payload"},"documents":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangeRequestDocumentPayload"},"type":"array"},{"type":"null"}],"title":"Documents"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"rejection_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Reason"}},"type":"object","title":"ChangeRequestRequestPayload","description":"Request payload for creating/updating change requests - sent from Partners"},"ChangePayload":{"properties":{"internal_record_id":{"type":"string","title":"Internal Record Id"},"edit_action":{"$ref":"#/components/schemas/EditActionEnum"}},"additionalProperties":true,"type":"object","required":["internal_record_id","edit_action"],"title":"ChangePayload"},"EditActionEnum":{"type":"string","enum":["ADD","UPDATE","DELETE","NO_CHANGE"],"title":"EditActionEnum"},"ChangeRequestDocumentPayload":{"properties":{"document_label":{"type":"string","title":"Document Label"},"document_store_id":{"type":"string","title":"Document Store Id"}},"type":"object","required":["document_label","document_store_id"],"title":"ChangeRequestDocumentPayload","description":"Document reference to attach to a change request"},"ChangeRequestResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestResponsePayload"},{"type":"null"}]}},"type":"object","title":"ChangeRequestResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestResponsePayload":{"properties":{"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"tab_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tab Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Register Id"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required","default":0},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done","default":0},"approval_status":{"$ref":"#/components/schemas/ApprovalStatusEnum","default":"PENDING"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"type":"object","title":"ChangeRequestResponsePayload","description":"Response payload for change requests - returned to clients"},"ApprovalStatusEnum":{"type":"string","enum":["PENDING","APPROVED","REJECTED"],"title":"ApprovalStatusEnum"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_number\_of\_pending\_change\_requests

> Get Number Of Pending Change Requests

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_number_of_pending_change_requests":{"post":{"tags":["/change-requests"],"summary":"Get Number Of Pending Change Requests","operationId":"get_number_of_pending_change_requests_change_requests_get_number_of_pending_change_requests_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNumberOfPendingChangeRequestsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberOfPendingChangeRequestsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetNumberOfPendingChangeRequestsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetNumberOfPendingChangeRequestsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetNumberOfPendingChangeRequestsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetNumberOfPendingChangeRequestsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetNumberOfPendingChangeRequestsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetNumberOfPendingChangeRequestsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetNumberOfPendingChangeRequestsRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["subject_register_id","subject_record_id","tab_id"],"title":"GetNumberOfPendingChangeRequestsRequestPayload"},"NumberOfPendingChangeRequestsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/NumberOfPendingChangeRequestsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"NumberOfPendingChangeRequestsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"NumberOfPendingChangeRequestsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/NumberOfPendingChangeRequestsData"},{"type":"null"}]}},"type":"object","title":"NumberOfPendingChangeRequestsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"NumberOfPendingChangeRequestsData":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"tab_id":{"type":"string","title":"Tab Id"},"number_of_pending_change_requests":{"type":"integer","title":"Number Of Pending Change Requests"}},"type":"object","required":["subject_register_id","subject_record_id","tab_id","number_of_pending_change_requests"],"title":"NumberOfPendingChangeRequestsData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_number\_of\_cross\_register\_changes

> Get Number Of Cross Register Changes

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_number_of_cross_register_changes":{"post":{"tags":["/change-requests"],"summary":"Get Number Of Cross Register Changes","operationId":"get_number_of_cross_register_changes_change_requests_get_number_of_cross_register_changes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNumberOfCrossRegisterChangesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberOfCrossRegisterChangesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetNumberOfCrossRegisterChangesRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetNumberOfCrossRegisterChangesRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetNumberOfCrossRegisterChangesRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetNumberOfCrossRegisterChangesRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetNumberOfCrossRegisterChangesRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetNumberOfCrossRegisterChangesRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetNumberOfCrossRegisterChangesRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"}},"type":"object","required":["subject_register_id","subject_record_id"],"title":"GetNumberOfCrossRegisterChangesRequestPayload"},"NumberOfCrossRegisterChangesResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/NumberOfCrossRegisterChangesResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"NumberOfCrossRegisterChangesResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"NumberOfCrossRegisterChangesResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/NumberOfCrossRegisterChangesData"},{"type":"null"}]}},"type":"object","title":"NumberOfCrossRegisterChangesResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"NumberOfCrossRegisterChangesData":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"number_of_cross_register_changes":{"type":"integer","title":"Number Of Cross Register Changes"}},"type":"object","required":["subject_register_id","subject_record_id","number_of_cross_register_changes"],"title":"NumberOfCrossRegisterChangesData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_cross\_register\_changes

> Get Cross Register Changes

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_cross_register_changes":{"post":{"tags":["/change-requests"],"summary":"Get Cross Register Changes","operationId":"get_cross_register_changes_change_requests_get_cross_register_changes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCrossRegisterChangesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CrossRegisterChangesDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetCrossRegisterChangesRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetCrossRegisterChangesRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetCrossRegisterChangesRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetCrossRegisterChangesRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetCrossRegisterChangesRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetCrossRegisterChangesRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetCrossRegisterChangesRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"}},"type":"object","required":["subject_register_id","subject_record_id"],"title":"GetCrossRegisterChangesRequestPayload"},"CrossRegisterChangesDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/CrossRegisterChangesDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"CrossRegisterChangesDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"CrossRegisterChangesDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/CrossRegisterChangesData"},{"type":"null"}]}},"type":"object","title":"CrossRegisterChangesDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"CrossRegisterChangesData":{"properties":{"cross_register_changes":{"items":{"$ref":"#/components/schemas/CrossRegisterChangeRequestData"},"type":"array","title":"Cross Register Changes"}},"type":"object","required":["cross_register_changes"],"title":"CrossRegisterChangesData"},"CrossRegisterChangeRequestData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"tab_id":{"type":"string","title":"Tab Id"},"tab_label":{"type":"string","title":"Tab Label"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"section_id":{"type":"string","title":"Section Id"},"source_partner_id":{"type":"string","title":"Source Partner Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done"},"approval_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Status"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"type":"object","required":["change_request_id","register_id","register_mnemonic","tab_id","tab_label","internal_record_id","section_id","source_partner_id","created_by"],"title":"CrossRegisterChangeRequestData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_change\_requests

> Get Change Requests

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_change_requests":{"post":{"tags":["/change-requests"],"summary":"Get Change Requests","operationId":"get_change_requests_change_requests_get_change_requests_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangeRequestsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestFlattenedDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetChangeRequestsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetChangeRequestsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetChangeRequestsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetChangeRequestsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetChangeRequestsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetChangeRequestsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetChangeRequestsRequestPayload":{"properties":{"subject_register_id":{"type":"string","title":"Subject Register Id"},"subject_record_id":{"type":"string","title":"Subject Record Id"},"tab_id":{"type":"string","title":"Tab Id"}},"type":"object","required":["subject_register_id","subject_record_id","tab_id"],"title":"GetChangeRequestsRequestPayload"},"ChangeRequestFlattenedDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestFlattenedDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestFlattenedDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestFlattenedDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangeRequestFlattenedData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"ChangeRequestFlattenedDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestFlattenedData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"register_id":{"type":"string","title":"Register Id"},"tab_id":{"type":"string","title":"Tab Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"section_id":{"type":"string","title":"Section Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"source_partner_id":{"type":"string","title":"Source Partner Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done"},"approval_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Status"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"}},"additionalProperties":true,"type":"object","required":["change_request_id","register_id","tab_id","internal_record_id","section_id","section_mnemonic","source_partner_id","created_by"],"title":"ChangeRequestFlattenedData","description":"Change request data with flattened fields from change_payload"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_change\_request

> Get Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_change_request":{"post":{"tags":["/change-requests"],"summary":"Get Change Request","operationId":"get_change_request_change_requests_get_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetChangeRequestRequestPayload":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"}},"type":"object","required":["change_request_id"],"title":"GetChangeRequestRequestPayload"},"ChangeRequestDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestData"},{"type":"null"}]}},"type":"object","title":"ChangeRequestDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"register_id":{"type":"string","title":"Register Id"},"tab_id":{"type":"string","title":"Tab Id"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"section_id":{"type":"string","title":"Section Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"is_list":{"type":"boolean","title":"Is List","default":false},"section_register_id":{"type":"string","title":"Section Register Id"},"source_partner_id":{"type":"string","title":"Source Partner Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done"},"approval_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Status"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"},"change_payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Change Payload"},"current_register_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Current Register Data"}},"type":"object","required":["change_request_id","register_id","tab_id","internal_record_id","section_id","section_mnemonic","section_register_id","source_partner_id","created_by"],"title":"ChangeRequestData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_verifications\_for\_change\_request

> Get Verifications For Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_verifications_for_change_request":{"post":{"tags":["/change-requests"],"summary":"Get Verifications For Change Request","operationId":"get_verifications_for_change_request_change_requests_get_verifications_for_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVerificationsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetVerificationsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetVerificationsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetVerificationsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetVerificationsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetVerificationsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetVerificationsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetVerificationsRequestPayload":{"properties":{"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"}},"type":"object","title":"GetVerificationsRequestPayload"},"VerificationsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VerificationsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VerificationsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VerificationsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/VerificationsData"},{"type":"null"}]}},"type":"object","title":"VerificationsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VerificationsData":{"properties":{"verifications":{"items":{"$ref":"#/components/schemas/VerificationData"},"type":"array","title":"Verifications"}},"type":"object","required":["verifications"],"title":"VerificationsData"},"VerificationData":{"properties":{"verification_id":{"type":"string","title":"Verification Id"},"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"verified_by":{"type":"string","title":"Verified By"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verified At"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["verification_id","register_id","verified_by","is_approved"],"title":"VerificationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/add\_verification\_for\_change\_request

> Add Verification For Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/add_verification_for_change_request":{"post":{"tags":["/change-requests"],"summary":"Add Verification For Change Request","operationId":"add_verification_for_change_request_change_requests_add_verification_for_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVerificationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"AddVerificationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/AddVerificationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"AddVerificationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"AddVerificationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/AddVerificationPayload"}},"type":"object","required":["request_payload"],"title":"AddVerificationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"AddVerificationPayload":{"properties":{"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["is_approved"],"title":"AddVerificationPayload"},"VerificationDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VerificationDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VerificationDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VerificationDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/VerificationData"},{"type":"null"}]}},"type":"object","title":"VerificationDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VerificationData":{"properties":{"verification_id":{"type":"string","title":"Verification Id"},"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"verified_by":{"type":"string","title":"Verified By"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verified At"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["verification_id","register_id","verified_by","is_approved"],"title":"VerificationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/get\_register\_change\_request\_summary\_data

> Get Register Change Request Summary Data

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/get_register_change_request_summary_data":{"post":{"tags":["/change-requests"],"summary":"Get Register Change Request Summary Data","operationId":"get_register_change_request_summary_data_change_requests_get_register_change_request_summary_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangeRequestSummaryDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestSummaryDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetChangeRequestSummaryDataRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetChangeRequestSummaryDataRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetChangeRequestSummaryDataRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetChangeRequestSummaryDataRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetChangeRequestSummaryDataRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyRequestPayload":{"properties":{},"type":"object","title":"EmptyRequestPayload","description":"Empty payload for requests that don't require any parameters"},"ChangeRequestSummaryDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestSummaryDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestSummaryDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestSummaryDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestSummaryData"},{"type":"null"}]}},"type":"object","title":"ChangeRequestSummaryDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestSummaryData":{"properties":{"total_count":{"type":"integer","title":"Total Count"},"approved_count":{"type":"integer","title":"Approved Count"},"pending_count":{"type":"integer","title":"Pending Count"}},"type":"object","required":["total_count","approved_count","pending_count"],"title":"ChangeRequestSummaryData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /change-requests/search\_in\_change\_request

> Search In Change Request

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/change-requests/search_in_change_request":{"post":{"tags":["/change-requests"],"summary":"Search In Change Request","operationId":"search_in_change_request_change_requests_search_in_change_request_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestSearchResultsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"SearchChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/SearchChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"SearchChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"SearchChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/SearchChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"SearchChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"SearchChangeRequestRequestPayload":{"properties":{},"type":"object","title":"SearchChangeRequestRequestPayload"},"ChangeRequestSearchResultsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestSearchResultsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestSearchResultsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestSearchResultsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChangeRequestSearchResultData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"ChangeRequestSearchResultsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestSearchResultData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"register_id":{"type":"string","title":"Register Id"},"register_mnemonic":{"type":"string","title":"Register Mnemonic"},"tab_id":{"type":"string","title":"Tab Id"},"tab_label":{"type":"string","title":"Tab Label"},"internal_record_id":{"type":"string","title":"Internal Record Id"},"section_id":{"type":"string","title":"Section Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"source_partner_id":{"type":"string","title":"Source Partner Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"no_of_verifications_required":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Required"},"no_of_verifications_done":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"No Of Verifications Done"},"approval_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approval Status"},"approved_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved By"},"approved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Approved At"},"change_payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Change Payload"}},"type":"object","required":["change_request_id","register_id","register_mnemonic","tab_id","tab_label","internal_record_id","section_id","section_mnemonic","source_partner_id","created_by"],"title":"ChangeRequestSearchResultData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/get\_all\_incoming\_key\_paths

> Get All Incoming Key Paths

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/get_all_incoming_key_paths":{"post":{"tags":["/ingestion-config"],"summary":"Get All Incoming Key Paths","operationId":"get_all_incoming_key_paths_ingestion_config_get_all_incoming_key_paths_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelKeyPathRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelKeyPathListResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingModelKeyPathRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingModelKeyPathRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingModelKeyPathRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingModelKeyPathRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingModelKeyPathPayload"}},"type":"object","required":["request_payload"],"title":"IncomingModelKeyPathRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingModelKeyPathPayload":{"properties":{"key_path_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Path Id"},"keypath_for_message_id":{"type":"string","title":"Keypath For Message Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"key_path_for_sender":{"type":"string","title":"Key Path For Sender"},"key_path_for_signature":{"type":"string","title":"Key Path For Signature"},"key_path_for_signature_payload":{"type":"string","title":"Key Path For Signature Payload"},"is_list":{"type":"boolean","title":"Is List","default":false},"keypath_for_list_elements":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keypath For List Elements"}},"type":"object","required":["keypath_for_message_id","data_model_id","key_path_for_sender","key_path_for_signature","key_path_for_signature_payload"],"title":"IncomingModelKeyPathPayload"},"IncomingModelKeyPathListResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelKeyPathListResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingModelKeyPathListResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingModelKeyPathListResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/IncomingModelKeyPathListData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"IncomingModelKeyPathListResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingModelKeyPathListData":{"properties":{"key_path_id":{"type":"string","title":"Key Path Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"data_model_mnemonic":{"type":"string","title":"Data Model Mnemonic"},"is_list":{"type":"boolean","title":"Is List"}},"type":"object","required":["key_path_id","data_model_id","data_model_mnemonic","is_list"],"title":"IncomingModelKeyPathListData","description":"Data for list API - includes data_model_mnemonic"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/delete\_incoming\_key\_path

> Delete Incoming Key Path

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/delete_incoming_key_path":{"post":{"tags":["/ingestion-config"],"summary":"Delete Incoming Key Path","operationId":"delete_incoming_key_path_ingestion_config_delete_incoming_key_path_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIncomingKeyPathRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelKeyPathResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"DeleteIncomingKeyPathRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/DeleteIncomingKeyPathRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"DeleteIncomingKeyPathRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"DeleteIncomingKeyPathRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/DeleteIncomingKeyPathPayload"}},"type":"object","required":["request_payload"],"title":"DeleteIncomingKeyPathRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"DeleteIncomingKeyPathPayload":{"properties":{"key_path_id":{"type":"string","title":"Key Path Id"}},"type":"object","required":["key_path_id"],"title":"DeleteIncomingKeyPathPayload","description":"Delete payload for IncomingModelKeyPath"},"IncomingModelKeyPathResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelKeyPathResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingModelKeyPathResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingModelKeyPathResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelKeyPathData"},{"type":"null"}]}},"type":"object","title":"IncomingModelKeyPathResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingModelKeyPathData":{"properties":{"key_path_id":{"type":"string","title":"Key Path Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"keypath_for_message_id":{"type":"string","title":"Keypath For Message Id"},"key_path_for_sender":{"type":"string","title":"Key Path For Sender"},"key_path_for_signature":{"type":"string","title":"Key Path For Signature"},"key_path_for_signature_payload":{"type":"string","title":"Key Path For Signature Payload"},"is_list":{"type":"boolean","title":"Is List"},"keypath_for_list_elements":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keypath For List Elements"}},"type":"object","required":["key_path_id","data_model_id","keypath_for_message_id","key_path_for_sender","key_path_for_signature","key_path_for_signature_payload","is_list"],"title":"IncomingModelKeyPathData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/create\_semantic\_pattern

> Create Semantic Pattern

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/create_semantic_pattern":{"post":{"tags":["/ingestion-config"],"summary":"Create Semantic Pattern","operationId":"create_semantic_pattern_ingestion_config_create_semantic_pattern_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingModelSemanticPatternRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingModelSemanticPatternRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingModelSemanticPatternRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingModelSemanticPatternRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingModelSemanticPatternPayload"}},"type":"object","required":["request_payload"],"title":"IncomingModelSemanticPatternRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingModelSemanticPatternPayload":{"properties":{"semantic_pattern_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Semantic Pattern Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"pattern_for_register":{"type":"string","title":"Pattern For Register"},"pattern_for_section":{"type":"string","title":"Pattern For Section"},"key_path_for_business_payload":{"type":"string","title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","required":["data_model_id","register_id","section_id","pattern_for_register","pattern_for_section","key_path_for_business_payload"],"title":"IncomingModelSemanticPatternPayload"},"IncomingModelSemanticPatternResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingModelSemanticPatternResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingModelSemanticPatternResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternData"},{"type":"null"}]}},"type":"object","title":"IncomingModelSemanticPatternResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingModelSemanticPatternData":{"properties":{"semantic_pattern_id":{"type":"string","title":"Semantic Pattern Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"pattern_for_register":{"type":"string","title":"Pattern For Register"},"pattern_for_section":{"type":"string","title":"Pattern For Section"},"key_path_for_business_payload":{"type":"string","title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","required":["semantic_pattern_id","data_model_id","register_id","section_id","pattern_for_register","pattern_for_section","key_path_for_business_payload"],"title":"IncomingModelSemanticPatternData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/get\_semantic\_pattern

> Get Semantic Pattern

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/get_semantic_pattern":{"post":{"tags":["/ingestion-config"],"summary":"Get Semantic Pattern","operationId":"get_semantic_pattern_ingestion_config_get_semantic_pattern_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingModelSemanticPatternRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingModelSemanticPatternRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingModelSemanticPatternRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingModelSemanticPatternRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingModelSemanticPatternPayload"}},"type":"object","required":["request_payload"],"title":"IncomingModelSemanticPatternRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingModelSemanticPatternPayload":{"properties":{"semantic_pattern_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Semantic Pattern Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"pattern_for_register":{"type":"string","title":"Pattern For Register"},"pattern_for_section":{"type":"string","title":"Pattern For Section"},"key_path_for_business_payload":{"type":"string","title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","required":["data_model_id","register_id","section_id","pattern_for_register","pattern_for_section","key_path_for_business_payload"],"title":"IncomingModelSemanticPatternPayload"},"IncomingModelSemanticPatternResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingModelSemanticPatternResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingModelSemanticPatternResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternData"},{"type":"null"}]}},"type":"object","title":"IncomingModelSemanticPatternResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingModelSemanticPatternData":{"properties":{"semantic_pattern_id":{"type":"string","title":"Semantic Pattern Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"pattern_for_register":{"type":"string","title":"Pattern For Register"},"pattern_for_section":{"type":"string","title":"Pattern For Section"},"key_path_for_business_payload":{"type":"string","title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","required":["semantic_pattern_id","data_model_id","register_id","section_id","pattern_for_register","pattern_for_section","key_path_for_business_payload"],"title":"IncomingModelSemanticPatternData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/update\_semantic\_pattern

> Update Semantic Pattern

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/update_semantic_pattern":{"post":{"tags":["/ingestion-config"],"summary":"Update Semantic Pattern","operationId":"update_semantic_pattern_ingestion_config_update_semantic_pattern_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingModelSemanticPatternUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingModelSemanticPatternUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingModelSemanticPatternUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingModelSemanticPatternUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingModelSemanticPatternUpdatePayload"}},"type":"object","required":["request_payload"],"title":"IncomingModelSemanticPatternUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingModelSemanticPatternUpdatePayload":{"properties":{"pattern_for_register":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern For Register"},"pattern_for_section":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern For Section"},"key_path_for_business_payload":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","title":"IncomingModelSemanticPatternUpdatePayload","description":"Update payload for IncomingModelSemanticPattern - only allows updating specific fields"},"IncomingModelSemanticPatternResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingModelSemanticPatternResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingModelSemanticPatternResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingModelSemanticPatternData"},{"type":"null"}]}},"type":"object","title":"IncomingModelSemanticPatternResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingModelSemanticPatternData":{"properties":{"semantic_pattern_id":{"type":"string","title":"Semantic Pattern Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"pattern_for_register":{"type":"string","title":"Pattern For Register"},"pattern_for_section":{"type":"string","title":"Pattern For Section"},"key_path_for_business_payload":{"type":"string","title":"Key Path For Business Payload"},"raw_payload_enricher_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Payload Enricher Class"}},"type":"object","required":["semantic_pattern_id","data_model_id","register_id","section_id","pattern_for_register","pattern_for_section","key_path_for_business_payload"],"title":"IncomingModelSemanticPatternData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/create\_template

> Create Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/create_template":{"post":{"tags":["/ingestion-config"],"summary":"Create Template","operationId":"create_template_ingestion_config_create_template_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_template_ingestion_config_create_template_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"Body_create_template_ingestion_config_create_template_post":{"properties":{"template_request":{"$ref":"#/components/schemas/IncomingTemplateRequest"},"template_file":{"type":"string","contentMediaType":"application/octet-stream","title":"Template File"}},"type":"object","required":["template_request","template_file"],"title":"Body_create_template_ingestion_config_create_template_post"},"IncomingTemplateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingTemplateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingTemplateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingTemplateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingTemplatePayload"}},"type":"object","required":["request_payload"],"title":"IncomingTemplateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingTemplatePayload":{"properties":{"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","required":["register_id","data_model_id"],"title":"IncomingTemplatePayload"},"IncomingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateData"},{"type":"null"}]}},"type":"object","title":"IncomingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","register_id","data_model_id","template_file_id"],"title":"IncomingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/get\_template

> Get Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/get_template":{"post":{"tags":["/ingestion-config"],"summary":"Get Template","operationId":"get_template_ingestion_config_get_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingTemplateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingTemplateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingTemplateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingTemplateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingTemplatePayload"}},"type":"object","required":["request_payload"],"title":"IncomingTemplateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingTemplatePayload":{"properties":{"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","required":["register_id","data_model_id"],"title":"IncomingTemplatePayload"},"IncomingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateData"},{"type":"null"}]}},"type":"object","title":"IncomingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","register_id","data_model_id","template_file_id"],"title":"IncomingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/update\_template

> Update Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/update_template":{"post":{"tags":["/ingestion-config"],"summary":"Update Template","operationId":"update_template_ingestion_config_update_template_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_update_template_ingestion_config_update_template_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"Body_update_template_ingestion_config_update_template_post":{"properties":{"template_update_request":{"$ref":"#/components/schemas/IncomingTemplateUpdateRequest"},"template_file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"Template File"}},"type":"object","required":["template_update_request"],"title":"Body_update_template_ingestion_config_update_template_post"},"IncomingTemplateUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingTemplateUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingTemplateUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingTemplateUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingTemplateUpdatePayload"}},"type":"object","required":["request_payload"],"title":"IncomingTemplateUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingTemplateUpdatePayload":{"properties":{"template_id":{"type":"string","title":"Template Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","required":["template_id"],"title":"IncomingTemplateUpdatePayload","description":"Update payload for IncomingTemplate - only allows updating specific fields"},"IncomingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateData"},{"type":"null"}]}},"type":"object","title":"IncomingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","register_id","data_model_id","template_file_id"],"title":"IncomingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/delete\_template

> Delete Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/delete_template":{"post":{"tags":["/ingestion-config"],"summary":"Delete Template","operationId":"delete_template_ingestion_config_delete_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncomingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"IncomingTemplateUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/IncomingTemplateUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"IncomingTemplateUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"IncomingTemplateUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/IncomingTemplateUpdatePayload"}},"type":"object","required":["request_payload"],"title":"IncomingTemplateUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"IncomingTemplateUpdatePayload":{"properties":{"template_id":{"type":"string","title":"Template Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","required":["template_id"],"title":"IncomingTemplateUpdatePayload","description":"Update payload for IncomingTemplate - only allows updating specific fields"},"IncomingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IncomingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IncomingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IncomingTemplateData"},{"type":"null"}]}},"type":"object","title":"IncomingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IncomingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","register_id","data_model_id","template_file_id"],"title":"IncomingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/create\_subscription\_activity\_log

> Create Subscription Activity Log

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/create_subscription_activity_log":{"post":{"tags":["/ingestion-config"],"summary":"Create Subscription Activity Log","operationId":"create_subscription_activity_log_ingestion_config_create_subscription_activity_log_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivityLogRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivityLogsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"SubscriptionActivityLogRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/SubscriptionActivityLogRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"SubscriptionActivityLogRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"SubscriptionActivityLogRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/SubscriptionActivityLogPayload"}},"type":"object","required":["request_payload"],"title":"SubscriptionActivityLogRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"SubscriptionActivityLogPayload":{"properties":{"is_unsubscribe":{"type":"boolean","title":"Is Unsubscribe","default":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"partner_id":{"type":"string","title":"Partner Id"},"subscription_url":{"type":"string","title":"Subscription Url"},"registry_callback_url":{"type":"string","title":"Registry Callback Url"},"header":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Header"},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response"}},"type":"object","required":["partner_id","subscription_url","registry_callback_url"],"title":"SubscriptionActivityLogPayload"},"SubscriptionActivityLogsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionActivityLogsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"SubscriptionActivityLogsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"SubscriptionActivityLogsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/SubscriptionActivityLogData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"SubscriptionActivityLogsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"SubscriptionActivityLogData":{"properties":{"subscription_activity_log_id":{"type":"string","title":"Subscription Activity Log Id"},"is_unsubscribe":{"type":"boolean","title":"Is Unsubscribe"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"partner_id":{"type":"string","title":"Partner Id"},"subscription_url":{"type":"string","title":"Subscription Url"},"registry_callback_url":{"type":"string","title":"Registry Callback Url"},"header":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Header"},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response"},"date_time":{"type":"string","format":"date-time","title":"Date Time"}},"type":"object","required":["subscription_activity_log_id","is_unsubscribe","partner_id","subscription_url","registry_callback_url","date_time"],"title":"SubscriptionActivityLogData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-config/get\_subscription\_activity\_logs\_by\_partner

> Get Subscription Activity Logs By Partner

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-config/get_subscription_activity_logs_by_partner":{"post":{"tags":["/ingestion-config"],"summary":"Get Subscription Activity Logs By Partner","operationId":"get_subscription_activity_logs_by_partner_ingestion_config_get_subscription_activity_logs_by_partner_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivityLogRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionActivityLogsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"SubscriptionActivityLogRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/SubscriptionActivityLogRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"SubscriptionActivityLogRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"SubscriptionActivityLogRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/SubscriptionActivityLogPayload"}},"type":"object","required":["request_payload"],"title":"SubscriptionActivityLogRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"SubscriptionActivityLogPayload":{"properties":{"is_unsubscribe":{"type":"boolean","title":"Is Unsubscribe","default":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"partner_id":{"type":"string","title":"Partner Id"},"subscription_url":{"type":"string","title":"Subscription Url"},"registry_callback_url":{"type":"string","title":"Registry Callback Url"},"header":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Header"},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response"}},"type":"object","required":["partner_id","subscription_url","registry_callback_url"],"title":"SubscriptionActivityLogPayload"},"SubscriptionActivityLogsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/SubscriptionActivityLogsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"SubscriptionActivityLogsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"SubscriptionActivityLogsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/SubscriptionActivityLogData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"SubscriptionActivityLogsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"SubscriptionActivityLogData":{"properties":{"subscription_activity_log_id":{"type":"string","title":"Subscription Activity Log Id"},"is_unsubscribe":{"type":"boolean","title":"Is Unsubscribe"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"partner_id":{"type":"string","title":"Partner Id"},"subscription_url":{"type":"string","title":"Subscription Url"},"registry_callback_url":{"type":"string","title":"Registry Callback Url"},"header":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Header"},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response"},"date_time":{"type":"string","format":"date-time","title":"Date Time"}},"type":"object","required":["subscription_activity_log_id","is_unsubscribe","partner_id","subscription_url","registry_callback_url","date_time"],"title":"SubscriptionActivityLogData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-data/get\_ingestion\_summary\_data

> Get Ingestion Summary Data

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-data/get_ingestion_summary_data":{"post":{"tags":["/ingestion-data"],"summary":"Get Ingestion Summary Data","operationId":"get_ingestion_summary_data","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIngestionSummaryDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionSummaryDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetIngestionSummaryDataRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetIngestionSummaryDataRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetIngestionSummaryDataRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetIngestionSummaryDataRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyIngestionRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetIngestionSummaryDataRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyIngestionRequestPayload":{"properties":{},"type":"object","title":"EmptyIngestionRequestPayload","description":"Empty payload for requests that don't require any parameters"},"IngestionSummaryDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IngestionSummaryDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IngestionSummaryDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IngestionSummaryDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{},{"type":"null"}],"title":"Response Payload"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IngestionSummaryData"},{"type":"null"}]}},"type":"object","title":"IngestionSummaryDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IngestionSummaryData":{"properties":{"no_of_messages":{"type":"integer","title":"No Of Messages"},"no_of_partners":{"type":"integer","title":"No Of Partners"},"no_of_data_models":{"type":"integer","title":"No Of Data Models"}},"type":"object","required":["no_of_messages","no_of_partners","no_of_data_models"],"title":"IngestionSummaryData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-data/search\_in\_ingestion\_data

> Search In Ingestion Data

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-data/search_in_ingestion_data":{"post":{"tags":["/ingestion-data"],"summary":"Search In Ingestion Data","operationId":"search_ingestion_data","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchIngestionDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionDataSearchResultsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"SearchIngestionDataRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/SearchIngestionDataRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"SearchIngestionDataRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"SearchIngestionDataRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/EmptyIngestionRequestPayload"}},"type":"object","required":["request_payload"],"title":"SearchIngestionDataRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"EmptyIngestionRequestPayload":{"properties":{},"type":"object","title":"EmptyIngestionRequestPayload","description":"Empty payload for requests that don't require any parameters"},"IngestionDataSearchResultsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IngestionDataSearchResultsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IngestionDataSearchResultsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IngestionDataSearchResultsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/IngestionDataSearchResultData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"IngestionDataSearchResultsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IngestionDataSearchResultData":{"properties":{"ingest_id":{"type":"string","title":"Ingest Id"},"partner_id":{"type":"string","title":"Partner Id"},"partner_mnemonic":{"type":"string","title":"Partner Mnemonic"},"data_model_id":{"type":"string","title":"Data Model Id"},"data_model_mnemonic":{"type":"string","title":"Data Model Mnemonic"},"ingest_message_id":{"type":"string","title":"Ingest Message Id"},"ingest_correlation_id":{"type":"string","title":"Ingest Correlation Id"},"receipt_date_time":{"type":"string","format":"date-time","title":"Receipt Date Time"},"classification_status":{"type":"string","title":"Classification Status"},"classification_date_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Classification Date Time"},"classification_number_of_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Classification Number Of Attempts"},"classification_latest_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Classification Latest Error Code"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"register_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Mnemonic"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"section_mnemonic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Mnemonic"},"semantic_pattern_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Semantic Pattern Id"},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"},"transformation_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transformation Status"},"transformation_date_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Transformation Date Time"},"transformation_number_of_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transformation Number Of Attempts"},"transformation_latest_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transformation Latest Error Code"},"ingestion_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ingestion Status"},"ingestion_date_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ingestion Date Time"},"ingestion_number_of_attempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ingestion Number Of Attempts"},"ingestion_latest_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ingestion Latest Error Code"}},"type":"object","required":["ingest_id","partner_id","partner_mnemonic","data_model_id","data_model_mnemonic","ingest_message_id","ingest_correlation_id","receipt_date_time","classification_status"],"title":"IngestionDataSearchResultData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-data/get\_raw\_payload

> Get Raw Payload

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-data/get_raw_payload":{"post":{"tags":["/ingestion-data"],"summary":"Get Raw Payload","operationId":"get_raw_ingestion_payload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIngestionDataPayloadRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionDataPayloadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetIngestionDataPayloadRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetIngestionDataPayloadRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetIngestionDataPayloadRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetIngestionDataPayloadRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetIngestionDataRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetIngestionDataPayloadRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetIngestionDataRequestPayload":{"properties":{"ingest_id":{"type":"string","title":"Ingest Id"}},"type":"object","required":["ingest_id"],"title":"GetIngestionDataRequestPayload"},"IngestionDataPayloadResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IngestionDataPayloadResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IngestionDataPayloadResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IngestionDataPayloadResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IngestionDataPayload"},{"type":"null"}]}},"type":"object","title":"IngestionDataPayloadResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IngestionDataPayload":{"properties":{"raw_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data Json"},"enriched_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Enriched Data Json"},"transformed_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Transformed Data Json"}},"type":"object","title":"IngestionDataPayload"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ingestion-data/get\_enriched\_and\_transformed\_payload

> Get Enriched And Transformed Payload

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ingestion-data/get_enriched_and_transformed_payload":{"post":{"tags":["/ingestion-data"],"summary":"Get Enriched And Transformed Payload","operationId":"get_enriched_transformed_ingestion_payload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIngestionDataPayloadRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IngestionDataPayloadResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetIngestionDataPayloadRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetIngestionDataPayloadRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetIngestionDataPayloadRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetIngestionDataPayloadRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetIngestionDataRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetIngestionDataPayloadRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetIngestionDataRequestPayload":{"properties":{"ingest_id":{"type":"string","title":"Ingest Id"}},"type":"object","required":["ingest_id"],"title":"GetIngestionDataRequestPayload"},"IngestionDataPayloadResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IngestionDataPayloadResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IngestionDataPayloadResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IngestionDataPayloadResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/IngestionDataPayload"},{"type":"null"}]}},"type":"object","title":"IngestionDataPayloadResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"IngestionDataPayload":{"properties":{"raw_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data Json"},"enriched_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Enriched Data Json"},"transformed_data_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Transformed Data Json"}},"type":"object","title":"IngestionDataPayload"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/create\_topic

> Create Outgoing Topic

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/create_topic":{"post":{"tags":["/outgestion-config"],"summary":"Create Outgoing Topic","operationId":"create_outgoing_topic_outgestion_config_create_topic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicPayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicPayload":{"properties":{"topic_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"websub_topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"OutgoingTopicPayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/get\_all\_topics

> Get All Outgoing Topics

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/get_all_topics":{"post":{"tags":["/outgestion-config"],"summary":"Get All Outgoing Topics","operationId":"get_all_outgoing_topics_outgestion_config_get_all_topics_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicPayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicPayload":{"properties":{"topic_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"websub_topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"OutgoingTopicPayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/get\_topic

> Get Outgoing Topic

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/get_topic":{"post":{"tags":["/outgestion-config"],"summary":"Get Outgoing Topic","operationId":"get_outgoing_topic_outgestion_config_get_topic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicPayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicPayload":{"properties":{"topic_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"websub_topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"OutgoingTopicPayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/update\_topic

> Update Outgoing Topic

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/update_topic":{"post":{"tags":["/outgestion-config"],"summary":"Update Outgoing Topic","operationId":"update_outgoing_topic_outgestion_config_update_topic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicUpdatePayload":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["topic_id"],"title":"OutgoingTopicUpdatePayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/toggle\_topicstatus

> Toggle Outgoing Topic Status

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/toggle_topicstatus":{"post":{"tags":["/outgestion-config"],"summary":"Toggle Outgoing Topic Status","operationId":"toggle_outgoing_topic_status_outgestion_config_toggle_topicstatus_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicUpdatePayload":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["topic_id"],"title":"OutgoingTopicUpdatePayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/re\_register\_topic

> Re Register Outgoing Topic

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/re_register_topic":{"post":{"tags":["/outgestion-config"],"summary":"Re Register Outgoing Topic","operationId":"re_register_outgoing_topic_outgestion_config_re_register_topic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicUpdatePayload":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["topic_id"],"title":"OutgoingTopicUpdatePayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/delete\_topic

> Delete Outgoing Topic

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/delete_topic":{"post":{"tags":["/outgestion-config"],"summary":"Delete Outgoing Topic","operationId":"delete_outgoing_topic_outgestion_config_delete_topic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTopicResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTopicUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTopicUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTopicUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTopicUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTopicUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTopicUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTopicUpdatePayload":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["topic_id"],"title":"OutgoingTopicUpdatePayload"},"OutgoingTopicResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTopicResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTopicResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTopicResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTopicData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTopicResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTopicData":{"properties":{"topic_id":{"type":"string","title":"Topic Id"},"register_id":{"type":"string","title":"Register Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"websub_topic":{"type":"string","title":"Websub Topic"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_active":{"type":"boolean","title":"Is Active"},"websub_publish_status":{"type":"string","title":"Websub Publish Status"},"websub_publish_datetime":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Websub Publish Datetime"},"websub_publish_number_of_attempts":{"type":"integer","title":"Websub Publish Number Of Attempts"},"websub_publish_latest_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websub Publish Latest Error Message"}},"type":"object","required":["topic_id","register_id","data_model_id","websub_topic","is_active","websub_publish_status","websub_publish_number_of_attempts"],"title":"OutgoingTopicData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/create\_template

> Create Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/create_template":{"post":{"tags":["/outgestion-config"],"summary":"Create Template","operationId":"create_template_outgestion_config_create_template_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_template_outgestion_config_create_template_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"Body_create_template_outgestion_config_create_template_post":{"properties":{"template_request":{"$ref":"#/components/schemas/OutgoingTemplateRequest"},"template_file":{"type":"string","contentMediaType":"application/octet-stream","title":"Template File"}},"type":"object","required":["template_request","template_file"],"title":"Body_create_template_outgestion_config_create_template_post"},"OutgoingTemplateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTemplateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTemplateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTemplateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTemplatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTemplateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTemplatePayload":{"properties":{"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","title":"OutgoingTemplatePayload"},"OutgoingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTemplateData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","data_model_id","register_id","template_file_id"],"title":"OutgoingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/get\_template

> Get Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/get_template":{"post":{"tags":["/outgestion-config"],"summary":"Get Template","operationId":"get_template_outgestion_config_get_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTemplateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTemplateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTemplateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTemplateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTemplatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTemplateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTemplatePayload":{"properties":{"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"},"template_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template File Id"}},"type":"object","title":"OutgoingTemplatePayload"},"OutgoingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTemplateData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","data_model_id","register_id","template_file_id"],"title":"OutgoingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/update\_template

> Update Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/update_template":{"post":{"tags":["/outgestion-config"],"summary":"Update Template","operationId":"update_template_outgestion_config_update_template_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_update_template_outgestion_config_update_template_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"Body_update_template_outgestion_config_update_template_post":{"properties":{"template_update_request":{"$ref":"#/components/schemas/OutgoingTemplateUpdateRequest"},"template_file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"Template File"}},"type":"object","required":["template_update_request"],"title":"Body_update_template_outgestion_config_update_template_post"},"OutgoingTemplateUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTemplateUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTemplateUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTemplateUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTemplateUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTemplateUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTemplateUpdatePayload":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"}},"type":"object","required":["template_id"],"title":"OutgoingTemplateUpdatePayload"},"OutgoingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTemplateData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","data_model_id","register_id","template_file_id"],"title":"OutgoingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /outgestion-config/delete\_template

> Delete Template

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/outgestion-config/delete_template":{"post":{"tags":["/outgestion-config"],"summary":"Delete Template","operationId":"delete_template_outgestion_config_delete_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutgoingTemplateResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"OutgoingTemplateUpdateRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/OutgoingTemplateUpdateRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"OutgoingTemplateUpdateRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"OutgoingTemplateUpdateRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/OutgoingTemplateUpdatePayload"}},"type":"object","required":["request_payload"],"title":"OutgoingTemplateUpdateRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"OutgoingTemplateUpdatePayload":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Model Id"},"register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Id"}},"type":"object","required":["template_id"],"title":"OutgoingTemplateUpdatePayload"},"OutgoingTemplateResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/OutgoingTemplateResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"OutgoingTemplateResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"OutgoingTemplateResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/OutgoingTemplateData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"OutgoingTemplateResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"OutgoingTemplateData":{"properties":{"template_id":{"type":"string","title":"Template Id"},"data_model_id":{"type":"string","title":"Data Model Id"},"register_id":{"type":"string","title":"Register Id"},"template_file_id":{"type":"string","title":"Template File Id"}},"type":"object","required":["template_id","data_model_id","register_id","template_file_id"],"title":"OutgoingTemplateData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Upload Documents

> Upload multiple documents to MinIO storage with the specified document label.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/documents/upload_documents":{"post":{"tags":["/documents"],"summary":"Upload Documents","description":"Upload multiple documents to MinIO storage with the specified document label.","operationId":"upload_documents_documents_upload_documents_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_documents_documents_upload_documents_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"Body_upload_documents_documents_upload_documents_post":{"properties":{"document_label":{"type":"string","title":"Document Label","description":"Document label for the files"},"documents":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Documents","description":"List of documents to upload"}},"type":"object","required":["document_label","documents"],"title":"Body_upload_documents_documents_upload_documents_post"},"UploadDocumentsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/UploadDocumentsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"UploadDocumentsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"UploadDocumentsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/UploadDocumentsResponseData"},{"type":"null"}]}},"type":"object","title":"UploadDocumentsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"UploadDocumentsResponseData":{"properties":{"uploaded_documents":{"items":{"$ref":"#/components/schemas/UploadedDocumentData"},"type":"array","title":"Uploaded Documents"}},"type":"object","required":["uploaded_documents"],"title":"UploadDocumentsResponseData","description":"Response data for upload_change_request_documents endpoint"},"UploadedDocumentData":{"properties":{"document_store_id":{"type":"string","title":"Document Store Id"},"document_label":{"type":"string","title":"Document Label"},"filename":{"type":"string","title":"Filename"},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Url"}},"type":"object","required":["document_store_id","document_label","filename"],"title":"UploadedDocumentData","description":"Response data for a single uploaded document"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Section Documents

> Get documents for a section record.\
> \
> Returns the list of documents (label, document\_store\_id) for the specified record and section.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/documents/get_section_documents":{"post":{"tags":["/documents"],"summary":"Get Section Documents","description":"Get documents for a section record.\n\nReturns the list of documents (label, document_store_id) for the specified record and section.","operationId":"get_section_documents_documents_get_section_documents_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSectionDocumentsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionDocumentsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetSectionDocumentsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetSectionDocumentsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetSectionDocumentsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetSectionDocumentsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetSectionDocumentsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetSectionDocumentsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetSectionDocumentsRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"record_id":{"type":"string","title":"Record Id"},"section_id":{"type":"string","title":"Section Id"}},"type":"object","required":["register_id","record_id","section_id"],"title":"GetSectionDocumentsRequestPayload"},"SectionDocumentsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/SectionDocumentsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"SectionDocumentsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"SectionDocumentsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/SectionDocumentsData"},{"type":"null"}]}},"type":"object","title":"SectionDocumentsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"SectionDocumentsData":{"properties":{"register_id":{"type":"string","title":"Register Id"},"record_id":{"type":"string","title":"Record Id"},"section_id":{"type":"string","title":"Section Id"},"documents":{"items":{"$ref":"#/components/schemas/SectionDocumentData"},"type":"array","title":"Documents"}},"type":"object","required":["register_id","record_id","section_id","documents"],"title":"SectionDocumentsData","description":"Response data for get_section_documents endpoint"},"SectionDocumentData":{"properties":{"document_label":{"type":"string","title":"Document Label"},"document_store_id":{"type":"string","title":"Document Store Id"},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Url"}},"type":"object","required":["document_label","document_store_id"],"title":"SectionDocumentData","description":"Data for a section document (label + document_store_id)"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Change Request Documents

> Get documents for a change request.\
> \
> Returns the list of documents (label, document\_store\_id) attached to the specified change request.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/documents/get_change_request_documents":{"post":{"tags":["/documents"],"summary":"Get Change Request Documents","description":"Get documents for a change request.\n\nReturns the list of documents (label, document_store_id) attached to the specified change request.","operationId":"get_change_request_documents_documents_get_change_request_documents_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSectionDocumentsForChangeRequestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeRequestDocumentsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetSectionDocumentsForChangeRequestRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetSectionDocumentsForChangeRequestRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetSectionDocumentsForChangeRequestRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetSectionDocumentsForChangeRequestRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetSectionDocumentsForChangeRequestRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetSectionDocumentsForChangeRequestRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetSectionDocumentsForChangeRequestRequestPayload":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"}},"type":"object","required":["change_request_id"],"title":"GetSectionDocumentsForChangeRequestRequestPayload"},"ChangeRequestDocumentsResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestDocumentsResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"ChangeRequestDocumentsResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"ChangeRequestDocumentsResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/ChangeRequestDocumentsData"},{"type":"null"}]}},"type":"object","title":"ChangeRequestDocumentsResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"ChangeRequestDocumentsData":{"properties":{"change_request_id":{"type":"string","title":"Change Request Id"},"documents":{"items":{"$ref":"#/components/schemas/SectionDocumentData"},"type":"array","title":"Documents"}},"type":"object","required":["change_request_id","documents"],"title":"ChangeRequestDocumentsData","description":"Response data for get_section_documents_for_change_request endpoint"},"SectionDocumentData":{"properties":{"document_label":{"type":"string","title":"Document Label"},"document_store_id":{"type":"string","title":"Document Store Id"},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Url"}},"type":"object","required":["document_label","document_store_id"],"title":"SectionDocumentData","description":"Data for a section document (label + document_store_id)"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get File Url

> Get the URL for a file.\
> \
> Returns the URL for the specified file.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/documents/get_file_url":{"post":{"tags":["/documents"],"summary":"Get File Url","description":"Get the URL for a file.\n\nReturns the URL for the specified file.","operationId":"get_file_url_documents_get_file_url_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUrlRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUrlResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"FileUrlRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/FileUrlRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"FileUrlRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"FileUrlRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/FileUrlRequestPayload"}},"type":"object","required":["request_payload"],"title":"FileUrlRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"FileUrlRequestPayload":{"properties":{"document_store_id":{"type":"string","title":"Document Store Id"}},"type":"object","required":["document_store_id"],"title":"FileUrlRequestPayload"},"FileUrlResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/FileUrlResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"FileUrlResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"FileUrlResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/FileUrlData"},{"type":"null"}]}},"type":"object","title":"FileUrlResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"FileUrlData":{"properties":{"file_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Url"}},"type":"object","title":"FileUrlData","description":"Response data for get_file_url endpoint"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /attributes/get\_g2p\_attribute\_values

> Get G2P Attribute Values

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/attributes/get_g2p_attribute_values":{"post":{"tags":["/attributes"],"summary":"Get G2P Attribute Values","operationId":"get_g2p_attribute_values_attributes_get_g2p_attribute_values_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetG2PAttributeValuesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetG2PAttributeValuesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetG2PAttributeValuesRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetG2PAttributeValuesRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetG2PAttributeValuesRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetG2PAttributeValuesRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetG2PAttributeValuesRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetG2PAttributeValuesRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetG2PAttributeValuesRequestPayload":{"properties":{"attribute_id":{"type":"string","title":"Attribute Id"},"parent_value_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Value Id"}},"type":"object","required":["attribute_id"],"title":"GetG2PAttributeValuesRequestPayload"},"GetG2PAttributeValuesResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"$ref":"#/components/schemas/GetG2PAttributeValuesResponseBody"}},"type":"object","required":["response_header","response_body"],"title":"GetG2PAttributeValuesResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"GetG2PAttributeValuesResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"items":{"$ref":"#/components/schemas/G2PAttributeValueData"},"type":"array","title":"Response Payload"}},"type":"object","required":["response_payload"],"title":"GetG2PAttributeValuesResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"G2PAttributeValueData":{"properties":{"value_id":{"type":"string","title":"Value Id"},"attribute_id":{"type":"string","title":"Attribute Id"},"value_code":{"type":"string","title":"Value Code"},"value_display":{"type":"string","title":"Value Display"},"parent_value_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Value Id"},"sort_order":{"type":"integer","title":"Sort Order"}},"type":"object","required":["value_id","attribute_id","value_code","value_display","sort_order"],"title":"G2PAttributeValueData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /ui\_helper/get\_all\_input\_mechanisms

> Get All Input Mechanisms

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ui_helper/get_all_input_mechanisms":{"post":{"tags":["/ui_helper"],"summary":"Get All Input Mechanisms","operationId":"get_all_input_mechanisms_ui_helper_get_all_input_mechanisms_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/G2PInputMechanismRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/G2PInputMechanismResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"G2PInputMechanismRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/G2PInputMechanismRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"G2PInputMechanismRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"G2PInputMechanismRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/G2PInputMechanismPayload"}},"type":"object","required":["request_payload"],"title":"G2PInputMechanismRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"G2PInputMechanismPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"}},"type":"object","required":["register_id"],"title":"G2PInputMechanismPayload"},"G2PInputMechanismResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/G2PInputMechanismResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"G2PInputMechanismResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"G2PInputMechanismResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/G2PInputMechanismData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"G2PInputMechanismResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"G2PInputMechanismData":{"properties":{"mechanism_id":{"type":"string","title":"Mechanism Id"},"register_id":{"type":"string","title":"Register Id"},"mechanism_type":{"type":"string","title":"Mechanism Type"},"display_key":{"type":"string","title":"Display Key"}},"type":"object","required":["mechanism_id","register_id","mechanism_type","display_key"],"title":"G2PInputMechanismData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /verifications/get\_verifications

> Get Verifications

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/verifications/get_verifications":{"post":{"tags":["/verifications"],"summary":"Get Verifications","operationId":"get_verifications_verifications_get_verifications_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVerificationsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationsDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetVerificationsRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetVerificationsRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetVerificationsRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetVerificationsRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetVerificationsRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetVerificationsRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetVerificationsRequestPayload":{"properties":{"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"}},"type":"object","title":"GetVerificationsRequestPayload"},"VerificationsDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VerificationsDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VerificationsDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VerificationsDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/VerificationsData"},{"type":"null"}]}},"type":"object","title":"VerificationsDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VerificationsData":{"properties":{"verifications":{"items":{"$ref":"#/components/schemas/VerificationData"},"type":"array","title":"Verifications"}},"type":"object","required":["verifications"],"title":"VerificationsData"},"VerificationData":{"properties":{"verification_id":{"type":"string","title":"Verification Id"},"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"verified_by":{"type":"string","title":"Verified By"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verified At"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["verification_id","register_id","verified_by","is_approved"],"title":"VerificationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /verifications/add\_verification

> Add Verification

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/verifications/add_verification":{"post":{"tags":["/verifications"],"summary":"Add Verification","operationId":"add_verification_verifications_add_verification_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVerificationRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationDataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"AddVerificationRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/AddVerificationRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"AddVerificationRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"AddVerificationRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/AddVerificationPayload"}},"type":"object","required":["request_payload"],"title":"AddVerificationRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"AddVerificationPayload":{"properties":{"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["is_approved"],"title":"AddVerificationPayload"},"VerificationDataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/VerificationDataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"VerificationDataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"VerificationDataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"$ref":"#/components/schemas/VerificationData"},{"type":"null"}]}},"type":"object","title":"VerificationDataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"VerificationData":{"properties":{"verification_id":{"type":"string","title":"Verification Id"},"register_id":{"type":"string","title":"Register Id"},"internal_record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Record Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Id"},"change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Change Request Id"},"submission_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submission Id"},"verified_by":{"type":"string","title":"Verified By"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verified At"},"verification_observations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Observations"},"is_approved":{"type":"boolean","title":"Is Approved"}},"type":"object","required":["verification_id","register_id","verified_by","is_approved"],"title":"VerificationData"},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /intake-form-metadata/get\_intake\_form

> Get Intake Form

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/intake-form-metadata/get_intake_form":{"post":{"tags":["/intake-form-metadata"],"summary":"Get Intake Form","operationId":"get_intake_form_intake_form_metadata_get_intake_form_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIntakeFormMetadataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntakeFormMetadataResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"GetIntakeFormMetadataRequest":{"properties":{"request_header":{"$ref":"#/components/schemas/G2PRequestHeader"},"request_body":{"$ref":"#/components/schemas/GetIntakeFormMetadataRequestBody"}},"type":"object","required":["request_header","request_body"],"title":"GetIntakeFormMetadataRequest"},"G2PRequestHeader":{"properties":{"sender_app_mnemonic":{"type":"string","title":"Sender App Mnemonic"},"sender_app_url":{"type":"string","title":"Sender App Url"},"request_id":{"type":"string","title":"Request Id"},"request_timestamp":{"type":"string","format":"date-time","title":"Request Timestamp"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance Id"}},"type":"object","required":["sender_app_mnemonic","sender_app_url","request_id","request_timestamp"],"title":"G2PRequestHeader"},"GetIntakeFormMetadataRequestBody":{"properties":{"pagination_request":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationRequest"},{"type":"null"}]},"request_payload":{"$ref":"#/components/schemas/GetIntakeFormMetadataRequestPayload"}},"type":"object","required":["request_payload"],"title":"GetIntakeFormMetadataRequestBody"},"G2PPaginationRequest":{"properties":{"current_page":{"type":"integer","minimum":1,"title":"Current Page"},"page_size":{"type":"integer","minimum":1,"title":"Page Size"},"sort_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"},"filter_by":{"anyOf":[{},{"type":"null"}],"title":"Filter By"},"search_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},"type":"object","required":["current_page","page_size"],"title":"G2PPaginationRequest"},"GetIntakeFormMetadataRequestPayload":{"properties":{"register_id":{"type":"string","title":"Register Id"},"intake_form_id":{"type":"string","title":"Intake Form Id"}},"type":"object","required":["register_id","intake_form_id"],"title":"GetIntakeFormMetadataRequestPayload"},"IntakeFormMetadataResponse":{"properties":{"response_header":{"$ref":"#/components/schemas/G2PResponseHeader"},"response_body":{"anyOf":[{"$ref":"#/components/schemas/IntakeFormMetadataResponseBody"},{"type":"null"}]}},"type":"object","required":["response_header"],"title":"IntakeFormMetadataResponse"},"G2PResponseHeader":{"properties":{"request_id":{"type":"string","title":"Request Id"},"response_status":{"$ref":"#/components/schemas/G2PResponseStatus"},"response_error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Code"},"response_error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Error Message"},"response_timestamp":{"type":"string","format":"date-time","title":"Response Timestamp"}},"type":"object","required":["request_id","response_status","response_timestamp"],"title":"G2PResponseHeader"},"G2PResponseStatus":{"type":"string","enum":["ERROR","SUCCESS"],"title":"G2PResponseStatus"},"IntakeFormMetadataResponseBody":{"properties":{"pagination_response":{"anyOf":[{"$ref":"#/components/schemas/G2PPaginationResponse"},{"type":"null"}]},"response_payload":{"anyOf":[{"items":{"$ref":"#/components/schemas/RegisterSectionData"},"type":"array"},{"type":"null"}],"title":"Response Payload"}},"type":"object","title":"IntakeFormMetadataResponseBody"},"G2PPaginationResponse":{"properties":{"number_of_items":{"type":"integer","minimum":0,"title":"Number Of Items"},"number_of_pages":{"type":"integer","minimum":0,"title":"Number Of Pages"}},"type":"object","required":["number_of_items","number_of_pages"],"title":"G2PPaginationResponse"},"RegisterSectionData":{"properties":{"section_register_id":{"type":"string","title":"Section Register Id"},"register_id":{"type":"string","title":"Register Id"},"section_id":{"type":"string","title":"Section Id"},"tab_id":{"type":"string","title":"Tab Id"},"section_mnemonic":{"type":"string","title":"Section Mnemonic"},"section_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Description"},"documents_required":{"type":"boolean","title":"Documents Required","default":false},"no_of_verifications_required":{"type":"integer","title":"No Of Verifications Required","default":0},"auto_approval":{"type":"boolean","title":"Auto Approval","default":false},"cr_auto_approve_for_bene_portal":{"type":"boolean","title":"Cr Auto Approve For Bene Portal","default":false},"cr_auto_approve_for_agent_portal":{"type":"boolean","title":"Cr Auto Approve For Agent Portal","default":false},"cr_auto_approve_for_staff_portal":{"type":"boolean","title":"Cr Auto Approve For Staff Portal","default":false},"cr_auto_approve_for_partner":{"type":"boolean","title":"Cr Auto Approve For Partner","default":false},"cr_auto_approve_for_intake_form":{"type":"boolean","title":"Cr Auto Approve For Intake Form","default":false},"is_list":{"type":"boolean","title":"Is List","default":false},"register_purpose":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Register Purpose"},"is_primary_section":{"type":"boolean","title":"Is Primary Section","default":false},"section_order":{"type":"integer","title":"Section Order","default":0},"section_ui_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Section Ui Schema"},"register_relation":{"anyOf":[{"$ref":"#/components/schemas/RegisterRelationEnum"},{"type":"null"}]}},"type":"object","required":["section_register_id","register_id","section_id","tab_id","section_mnemonic"],"title":"RegisterSectionData","description":"Section data for a register representing UI schema for a section."},"RegisterRelationEnum":{"type":"string","enum":["SELF","DESCENDANT","DESCENDANT_OF_A_REGISTER","ANCESTOR","PEER"],"title":"RegisterRelationEnum","description":"Relationship type between a section's register and the queried register."},"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Get Ping

> Returns "pong" always, if the service is healthy.\
> This can also used for service health checks.

```json
{"openapi":"3.1.0","info":{"title":"OpenG2P Registry Beneficiary Portal API","version":"2.0.0"},"paths":{"/ping":{"get":{"tags":["ping"],"summary":"Get Ping","description":"Returns \"pong\" always, if the service is healthy.\nThis can also used for service health checks.","operationId":"get_ping_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorListResponse"}}}}}}}},"components":{"schemas":{"ErrorListResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/ErrorResponse"},"type":"array","title":"Errors"}},"type":"object","required":["errors"],"title":"ErrorListResponse"},"ErrorResponse":{"properties":{"code":{"type":"string","title":"Code","default":""},"message":{"type":"string","title":"Message","default":""}},"type":"object","title":"ErrorResponse"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openg2p.org/products/registry/registry/developer-zone/api-documentation/staff-portal-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.