From 69c25804b4f6ce102eec19643c159f5ef0c02c3a Mon Sep 17 00:00:00 2001 From: Dhananjay Date: Thu, 7 Dec 2023 15:29:33 +0530 Subject: [PATCH] Refactored APIs --- release/html/dci-logo.png | Bin 0 -> 11541 bytes release/html/ibr_api_v1.0.0.html | 20 +- release/html/registry_core_api_v1.0.0.html | 4 +- release/html/social_api_v1.0.0.html | 16 +- release/yaml/ibr_api_v1.0.0.yaml | 271 +----------------- release/yaml/registry_core_api_v1.0.0.yaml | 4 +- release/yaml/social_api_v1.0.0.yaml | 265 +---------------- src/common/schema/Identifier.yaml | 19 ++ src/extensions/ibr/Person.yaml | 45 +-- src/extensions/social/Benefit.yaml | 11 - src/extensions/social/BenefitType.yaml | 16 -- src/extensions/social/DisabilityInfo.yaml | 16 -- src/extensions/social/DisburshmentInfo.yaml | 19 -- src/extensions/social/EnrollmentStatus.yaml | 13 - src/extensions/social/GroupType.yaml | 11 - src/extensions/social/Households.yaml | 0 src/extensions/social/IdentifierType.yaml | 7 - .../social/IdentifierTypeValue.yaml | 7 - src/extensions/social/PaymentStatus.yaml | 9 - src/extensions/social/Person.yaml | 80 +----- src/extensions/social/Programme.yaml | 25 -- src/extensions/social/ReceiptInformation.yaml | 13 - src/registry/ibr/SearchResponse.yaml | 2 +- src/registry/ibr_api_v1.0.0.yaml | 2 +- src/registry/registry_core_api_v1.0.0.yaml | 2 +- src/registry/schema/RegistryType.yaml | 4 +- src/registry/social_api_v1.0.0.yaml | 2 +- 27 files changed, 73 insertions(+), 810 deletions(-) create mode 100644 release/html/dci-logo.png create mode 100644 src/common/schema/Identifier.yaml delete mode 100644 src/extensions/social/Benefit.yaml delete mode 100644 src/extensions/social/BenefitType.yaml delete mode 100644 src/extensions/social/DisabilityInfo.yaml delete mode 100644 src/extensions/social/DisburshmentInfo.yaml delete mode 100644 src/extensions/social/EnrollmentStatus.yaml delete mode 100644 src/extensions/social/GroupType.yaml delete mode 100644 src/extensions/social/Households.yaml delete mode 100644 src/extensions/social/IdentifierType.yaml delete mode 100644 src/extensions/social/IdentifierTypeValue.yaml delete mode 100644 src/extensions/social/PaymentStatus.yaml delete mode 100644 src/extensions/social/Programme.yaml delete mode 100644 src/extensions/social/ReceiptInformation.yaml diff --git a/release/html/dci-logo.png b/release/html/dci-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..e6498196572b0bba41d29617f91d1d9c3d49d8f4 GIT binary patch literal 11541 zcmXY%WmFqo+lA2M((#Ube6`I*@>4{MHRE*bbk>NB2Hun;hcz&ZnjwjH3N%WZ{%?UXHS2kDX1#}CfYbY_X?{bTWa&E>aGapOalj$n`N(q@3MRCTk z_^^fT%DyWTrL6vqKJl1pJ*Zl6H$vkZk(fqAVhdIE`DflLXi~HXDYcsMS2vb0RyB+K z2XXlmlw~}PgulJ#6a#RL2fmUW9O$Dqe!~SOvkj;&5Nw(x1*TQJ3Ie5|T}F(ZPZ4I) zgryu6U(&C3221FhwaQ;OsSqb`t(+7r4~H~M=IIHKxy3tL8uvbMzI>7V`IsFBH*r}Q z3L24Xi@|1KuQU8K{i}-69+y|OAW}Op+`b3`mV99T{}a;Rts{N67W(#TQoiG4r}m+Q zF6*0x5uX93cR^;5GRrIifUrdip^QVwW^QzvZ$RjdNeB$odmY$gBILDG5G;a`DB;)xH*wA9u(or@qrFUf#>Pv+M^aD-Z%TT5;E{i3x^! zMuL(f%n=V}6*wyeCeF7D(2@mrpEZsHIQ@Q_BleLiG%(|ozWdX+Az=M0d-zo*k^mlX zIA$!F=EbB8n{uda67Q4A{?EXWyl)zbX9dqJ@C^w*eq?m&H$Bu0t~ChJU$N_Y5BIG< zSNU;WbzU?<#nSrm~q!?IKmmi`O* z6vq~2pyWPCDuG?tLw(OM@zVY8EXjX*L5EK1;44=3GwS^w^C$@)7g7gu=F1FW2eLjN zRZJPPj70)z4Z>>|Pvw-SpTrdel(hD5+X@PgHQ3e0bghJ20iHh&D&fE{c6tWJylyNE z5h~cwxC{9>YRUZ%GrVD+$G#TZ<+t^g7P@>igPV|?<2`#Lo{qLcsbIY6krFf<7{^`D zq-}WBDqf*xAsDhc_cPHPL#<8Kdv4B!63*PlG(^jG# z)PA9j7G-n*lBXuMSxa^5l1Q0PoqrOzj+Nz9+R=gfBl5lT7jwJdIXV{RjcY ze|@H4BOgxo6{%NlhPA!tkI{lbBSb~h ziyRBV%(6a*`a1f)$QcaZwq(D*=}Qxk<$dpDvz;-Q_my#mYEE(Rndn6MW{YjvweXlO#dH#33h5o_~sl4kYt zhB&q|O>p2_^ABJWkxxlsp}xdx*5*vQ0N^kKK^aGKCPv%fHoW4h6^80edbd^birBbB zsl~{jRXW_=+L8C>adYy@G)8s{2$~uMRRP2n=*%UILTDyqJ9lCs%xYGD{PA{P%?Ad< za2oZHH5i{hySuOLJ3fxj6k=>GFHY5G!F9j)aGw;34<*UHJq>=l!zRKhU!ev)LQa(A zj8uO_2rS$X8~L_6c@o|mYsy%a#7hL62-1$=1zt|O!3JH^gHB>qpwFyxI%Fh_a7+RD zVpv4`8$8gD`mQc8Xx`PB>9DZ|2l$@a>|mpyDY9>vchT6-&NS|hgrU<{HDAyxH z1al=M2_OfJo+~rBi~vpyd=Km+ao+xDHqYttR)Z>}1b$(5=`;;Bs(m7jS@||Bgdjh1 zZ8@bd8?>BEEDQz-{g2=?JUcS!K#58;&t#SEq>n_N5Kf#m-(DeNOM+pT}Otu&#l)LEigM0PtT8Bnm8jBfIH( zD~*D=qh9ccf22$9$}N);zA2e4^h1vV@~5F;RE35&h?jX9dMd@EP6hX?2rtEQkKz5x z?)$$$EBVUJMApMFEds}MmEN6Vjx!}WZs(i%H%%<;Qjm)b8=LEU$A*Wh3#|N4QDp9v z+@X?LiFbsn^?C{MCKMg9Cam{FtQo)jA zUUT-huSlzlJTILR7H5MO$t~{O0&VgFRyj z{mu_Q`=!PG{eo0BUTdVUS8uU}vK8P2H#Tn<`;jDTW`S5?^ zL%!3rW1Hj^NGi71FLRUPdZOQvF3g;c>6r)QDG>cwSE#`2VSCR=&QzBIg{qIH^@mr21{GMLRvFZGScrl^e z!urqV{eTw9vbMizyG@IRSgQq>7_`6b!Q*)~e|cXuB7h18>~*nN&1XH;SY z^$sj`-XID`pdSSLsu|q-J^dh3vbM4-c&p17b<)0&AAlqkujan4ZdHPv4;merL5ZeDR9Z{E zSvxrVpXyGlvUAMigLA&YVBD`=3Q{H9%Z&9urCA=m7T)&+rZO^fNZnrU_?q31iL6<{ z$SEDn_Sz>8?3R|)MOUWdLn2cZT!()VDbAEF$;hfsrEkPpmNHZRE;^2sn76lpi_Deh z9XCR4?2fX`$GR*w&(yE;FN}ts4u<jn{&iR8+%00%-KzKzG$#UDpq|0k3Jc0rzkF7gagb{Kk^*EIJlwnUq6z9mEaC zU}VoyVcAt%J7I-)oxB;H$V^An3WBU@oUcM)mQ-20;9nv3 zDl(T0Q#srB;!QcL<>}>HImBCHfFDMosF zt{c}RZ8#VV(Jz;=@L!o<*Zt)toS;v8~uXsHtQSmo=y{I1RiHfd8z8R8c3Cv6W>WkS+yCcIlR40?1w2O!57 zK0H51bur&L!5*dOmon*0!Lg zEV!$J$EKYc!aq{R6%V8M5s$GVtFR_lTkW6H{6WjOp)tuwZ>S>HXKEHIjpE^K&d(0U z@e1;QWQQ(oK8V|}k8v;P_&ikmuK8G3##N}GRv<~$sC|MKwn1mpF9Qf%g38!%x(0=; zw3uL`$&%UO2BxMEsFGu20RfNUpTF(~AxHG`0Swj*q#Se;`2GPF1;ScEa`YTc@eMW? zIAZuh;(-n<3xtPXh>nGoP(ro7Fpb<%^r}sn%R!^t(xNfD6@YS1M}1};G10+t<=kQQ z(dAn3#nG1!IBD@bRuwBnV`={VbbY3!H|+T>!o9!r>514fw4#!#T};AkQl>0O$zZ~x zKdTK#Vp(iJw$w+>O?fFdc{CA?ZzeuDr=@()%ceE)-kLJMFnSC%1)GFO_8Yy)`mu$Q z3`7I}b(;V;QTTV-Ka#8PRzbI>qf0jk-AIm1leLw-ut1~SW+6;ncEn0gG}MIs7*dij z>u4bSOL65;LcpD$t1QD(GHsGQ`vCWL;GLi3Z9HgK`DM#Gug*HJh^5XW_M|qVL{|z5 zI7Ps^urX#f&RAF4iTRflxc^SObww6#GKnW_=cBhNc^PNcU+!37-hOtLvG-hqeYu^A zni5L9#(?s?xspH`1|6^qubrYJy3G04YLm0}k@4PItq3*9H)&fdk^1j`?%TLp5$xbo z#p~N3&CQd1fVPLrM*Z$dgU2^x!@*zr3-v|px42W70h}&7c8W~uZ+{@J@s0{DQM0TT zygQ#nOiK(pkzD71%S+kN_Vy1gf&Q5J>&8<(IziNb$%`FW$5w|1BX%hCuTHL*76nqX z9f`5zEG$t}dq(`CwUVIoM@2S*lwh5+^SqrZqqs!oFW>BVP$yA%xO+J7| zn{g@6S0(q@F*2B~4kI>WYk-%xIM^C2+jL}kL{|4BQYY&8x2k6t@Z3O)i5oe>qZgSV zK$+o8U`mLg#Mndc&2-u!C0k_j2Mb|Ehbma-n?>biCX(1thh!)VA&*eD--z7Yz?t`? z_~KfUQDH(RQ_eW=A@lDvv>ZpWiMmz`!x$sIy#F4#J$osusvZt={YC3r<0_|DN(Ub` zYE7EXC`XFEoBFi!(R9yumktuJHNcELQb*xtQ+Lw$k9;FZ_;8p$X^py3iA}X#8KKn@3rt z?yS*O1;W;@PDU{c{|J#-DIuw%?sgb55m{&)?P@AqY0P-nq<;Uoi>bOwM0}h*6XqJ3 zR-x*)ann^M8Jk{S6z>ge^JS_l2>bgbE;eOqK_pRuSP0 zsIa0XMG8*+0}pnL)FQr`#1+tX5#&$Wfk6%VBxGJyE5+1&hqNKPDy#yBV2|D%bF-w* zPM#Qgbc1ktBh>_l^dY;-+X?c3+onCDAEQ9d^-p&~!)$OiUqcb8sJh&`ycR>Z+ibY< z)F5a`yR3%KZadVdN(i7PjYLW%%Uc47 z(z{K%x`({UqxbUsiY+T&6Ec6PViO6*^wdUzJ;J?dj!=t{?JnD`kkB_>>QM4^<`)-ZxgpbXE_V zFHGbQ4bp1FJ#%(xne-OIFF_by-l|vgZ@2+B=lthp`l`KYFaH+R+?tAn?Qqb2P@X(s z>bA9wuTQ6GAkg=kF|%k4CSv1^_EO_qMZ-sW3kl*kre%5Ut`^O+B)(UM>>N|Tym&_2 zBzRX_v@SI&7W2_go+pNu(b5C1?a?Q)>amKk`P8qxE8N= zojygWz+{kyqTxX>MM+}e`z#pvlu(^V>-9oSFN*9v?{gEH|`dlj2c)=&u1+;JF_0QJaEl{PI+Qe}@bC{ZfnLQrTCNF&Sr-$lxqn09obgviaZko}|w=2TAa~AUcGPvMAwcV$_&Xk+pp%gS; zrU~|+oZ%XL-sPzV}XSr zYbh}Al^tU(l|YF-i~Rs|86>h7#jZ|GQpoOj{b=;nKo6gW>bkZ~eBjX8{xehn5gkh z+K7z)!i+%T?%*A&9{tOD1Ah<;AeRG1hg$4GF?l0+AD^{tfNQA({!x%`cEx{~B}MJ( z>V#BaDzvjx@tXtXuYX2ieqy|S~YA0rf&U$#VA}>b+!HS;RyGNdH&CfYKd^)2>CLwnHrcnEe+v|pq-J85# zguMAj)C1oIlAGzH39Xq}o zloZAqLFABO2kE)j;gID;Ef>Xk3#*vmTxNZtA12!BS~F!1ljIc41+to0TDfPGDs3?t zG73;M>O8@E17|LqtD|5DfO1hF7fmm#ZHO?|qN~~WC%%>8|MZ`gC*gZzLw?y^yvyk* z^JgBpyg-K(2P4|X0soF=@m`(E;gqfIY>s~k>}>>2ADJxZbm{DvhqRCjI_evTUgs6m zS6-ERw>|QLs|~gYGVk{~OXdBS$9jWUvv54(Y)1&4!hzQ>uhARDXjpM9uBq}{)@cO_ zz)#xJ@XnZ@4Kq<@aBe2WvCHE@hI*9S6I}#NRf6J4^6BRtA5N}8o*kueyUcA2Za;=# zwYn4E5G`)Ni;x~dpW2KI{5?rb*UZ^@m}^v=BE1Y+-y@N?>2JL!p4QsmZ4ltU!d~;O zKm)aS+7PB`<`t&13E!&it<(qp?5Ys$1_4>BPKYv#^rB`TXtaGz1%XQ)rKsb}A~kI{ z8N#q`c0R)-4B`GQ6rXHVYtkm)pc5vx4DNF^?l}AjA`>O9db%gf__bdK0 z6wcDvi`xHu1hadm>4QFxM|89!2sPenT)FNo4yuH0rHLHEFnBVuMnR?aOY?JyjU8-& ze^*qQD|#0A#S<6|tr+S8y==1&DQ+;;orDaFSTlx~DM%*^91xW8eb{pMBjK{Ye&Ut& zZ$Z0m>T|HqDBD2Sp1aHzjyp|aX-%OBD?}AN{8=DrXiwlsj12pys6MawUmu@*9nb# zo03~XW>C)!bme+P-WQp+ht0Fz4}lCmF8+K1HRXN46BVEnT9XLJSt|Q7-3`A~jnuS* zv5Ut3hy$7r<~K7!;98<4g_jPI=SJU3pQ*mYjYPfTni16mf4#LdiesabU~Kww zJkQ}Xa84kxFD)@&@NsWj(e6KlOnI(4x=2mz?O%n@nDZf+z$xN5!bZF%i7x4 z7JE60{1PkD{k!g<3ek}qp7++yzb1qT6V!cN{)e$&840|$0B(YYM;4H5D}+$pv$ z%u^mz51Wau^=>(x9>DbW)k`54KYzqy?(^CvZe41UwQqcqa4ll2 zw#l`0ilY6I@B^)n0}(MtzBjpsb@_svkU@g9EUz z2$`0XvT7rmWPgGqU(RM(fPdomV!@!Cn&@(#d5B6HR*p#fsA>CbE!`YoY z>y4s%SY?`dKDyL5Gdzj3`W{!A!dV|4llrHyVy}E9><-NXPdd6{;L;cn<`w)q-29?? zk45Fm{QOOGUb&LfYZAgnAhN-FEAZb=Nao>aJ zu#R^A8@FSN@r34C8E1LWyA|U**e1v>Pbn)vRu+U*t;W@L!#-}E)!VfvInIga=({K9{^Vpww7y&m<}@hDE|o1n{FzCya&(*P-ofh^L9=cos6pRRs)VX-_-PT&EM zt`Z_R)>r%9muGwP#nu$3Jn|O)NWD;njCcg;tB+s8%CvDi>nI{Q9!c8}jQ3nANE|~i zyl*ua`EbxPU^K$-G&O+Pj|k?w1bl;60w=ePL2avk+9kqg`%Sv3e!C@7%&dbDf%(aR z57i6s=SKSd&1U4#8nd&5!dO%Us*uS#jIDK{AAcoH=6R~%28- z!yi`NP1d`Z)n*bMovC4kGLMX<#8U3lu$aD1!~TS3*OjFJ^;$v?EY10-?dQ8hBd*PW zdpFK6=)Tx`0Cx6*n+q>RS!xXTdAp>8ef^?9D3f3k!yQI_mB>hLRaFbj?>pRKTs>@B zSV~2+WcLe#EsdU$B*Zu;bE^)ChdRYt!z5vI^{X5GxBm#(vOf@%v5-Yd@6ArXe!w<) zSNvv7^~;}e;%bI9*NW5;=w(1fMx|{9`t)Vk0VYlA3z^36e(k~-l%ZCD<*m81pm<=C0=~I$ zc7lfQr?zO}Vj9fLiUJqLd{kpA3%pISi@~V>y9(-CS=OG_`3wKbuF>0mn6*|!W(H53 zgXwZ>f+2{^U>T~+N<@(coS%l9%th67!#a@rU5c6j)@Jf^hXrlLDxby%wD zPdsgjC7t2k9U&|?rJT3{@1IdA(I>XfSD^gdM_l@RbKMQ~_$zNy>Js$`LRD5?D%e5$ z6#oYQ-3Qf?6b=rf=YMMf$|+JcDn(sNkCcja?6P_sj$p27(~BvE4jHn41=AU%UuM%# z+;km6hYVWn`H#2`Y~aV7{-Z}|I5yc|ro+Clyu9k}Q;nOjcQTpd#AjoDhUQy-pk-X5 z7jVfjp2Ag{`*lPm(N#)_^mWl3iFoVv6QN46^4V!_sXMRorWYy*LvKO9wyO^M8>=vh z78ajbIxq1a2g|4qjPWTKvF1*+Fqy+LHwJkg7~tc>?dJ1-Z-X?z*jdcll1|-A;~uQ^ zz1;RN!n$(y*U7GMl^F|IWC+vdd(l{bG&z>oV`q$yA=AiBI{(wJP$_KK^vHNm%Qu`; zoXqP6iYkY}0G3IHMBp8g#HPS#(^hxffMbXp^F?i$Z&rVZeN>!`w#^TRG+DdftlgCZ zuJjVC64IaccEb1TT0an0m>WF{b|!N}^!wr`TIG+Wy$lG0H{P!J6H* zlmJ6ze|bYp=H7s4j!~p`scG|4({GiZ!{N zWp?X#qvesh$Ghrdz->?ZCAi%|3ei@rFEvUAktxsLA*Hth;VMDS$TQ)fCEl*5Z+6Ue zAuo~wCMxPm#m8SASVlalZ68Kzv`GZHIKb5o2vxSIV}Xax(<;%9hk)?>H<5aih#6Us z{gQO5&c+?%6*;wZ1G{%`PMqV2&EbrqB_MghlQ5&L$BR%5-!S00J%WpO5If)|tD&!z zS~iDUIi)Z2h~c?UfQc#)QJDq5G&EdfS?w}!tEc(SOH`RZ(f_aOdU|)XZ#}1Ckc$(V zvv|mY7vFc9Hgk9n)mm63$a+E(hSYZiSVrCL@IHSplaiXQ+WmvEd6ZKGIAA!R8}`8B zxf+*9q88+unhbXvE*Inp&dnL9{K<9K=gstwLW(JjXYIRfDMRM^o!ARo6)L;oGuRm# zfvnW4Q#v5gy{bHuCfZRE_j8NJ#ARhuT&j}svAH=Xx9p(+%A0MJxb}{5J#e~TXVEbE zt5k7)QegP6Gr$8U-9B_29dp))vh-|5$z=A&SBXK#uOWu_lRy{Ptko`YW^Z7K27Rkw zP7?13=?$6E$RQDxsAGb-5TY55)0T(={Y;s{lBc??NF{!A^2Vw=R_>lGGFlzuA+HV2 z@<9Q~i$2?j|9xMeXhkki91#+tmBhy@9w0p}^st-~O1_R`;TrNC>AXWK^bJJ(yD^ET z8KvcxqyjO`L0n^Mx`1B_FtT)zHkYfcE#gC&=)r)vM!mZKGYMWntxNkDxa-S{b$&>Z z_1P}&8E8iF?z#E{mRgA^=0xv>{Cwy?L$kMVt@1P871?d@ z)UKf$eV>7~dSS}#`}S1k%D>yQmhBtkA2@a>9al&@4(DZ0iwe`CU7#(^*%HA;byqi} zjZ?^0?b+`OW0Yg*R;McFynNQ>gl zGG-`jf-n2}89qKJOO->pV%n2yX?W*L7z<$=4oRCN(}C7~DR`n}(!>yq$;Ip1y7ne2 zNLvi3{mO5y(@euNx6jtAbUWt=1R#CF84SDu4yU=5gT*w4b8V{9jU%~M6wbq(i;DZ^ z>WL)NebmEt5R#SPoqlR!F&-LM89RYfsXx%1UuoBCp5NCN*fZ zm~Q=&X16s%8GaDOO#C+<)*&akT?!ng+KLcnW2I$$hDX6PYec(9@|<74A*qXP?gZ}6 z76(%*Fg!+3Zmc&ng+G76HbG4mg#hKAqWo2GWKO$>=X$^@JnA z)^$8sUH~@F@^^Y;|Gdop!E8~w@?P^@o)ep}s~ji;R{-Tc8Gt?3RtJX;P~uHZAln{6 z;5v+o;QpB%-l|iU7N7~{vu`P=(>+U-O;csJ9^@vxnOljEAZ9Fc*<=PV+lcYIA#EH9 zP+B24X*?^TC6u?#dT~(S#%SC%2_)8=``V~MpLHP`iz>YxNnif@&~5dyPn~=!7Tl;z z(o51?qK~uT!?GzmX1GCoL63wsbv)M1+-$o!O|)Bb$MxoAB=859y1Awj8iX0S;w3Yf zmuJrlukb-TwBrK{o()gUwvt+m^)NA|-eMTcyYoU2Q8b&@LQHe(bb@4;`&lTpi*K;5 z3Pv1qwO^p6!WvOe8Pp)lES=s`ZXb}|=y40;m;_0V8lPvLtKaTcS`EaD7_YS^UVCw-d;+Q zGrr3_7()JE3ycX>bWG&s(J4e|8Fzo0Olrv&Xe(t(G4?B!A4y!U7Y&&P9viO_(HqvT zxH{r>mn1R?{wUCJld3BiL7?U{mZjA-pKrwN=*0ECWPGIMDEts-z6W$cH)K2*lL^oP z{jPO~dPa3V&(L~i#5!=E>KEzi6h8K&j78LT*lp7E-4+;9y-ZYbu=e>P0gzJR@#m&N z{~ie7<0pgO=#a@_#%1z~6{g9+4pr9L$|+ZDlxKfc(@vv3Lm*)10~qrg^dbP5fk-B9 zoMY?%4U^nJF%tM~lEzsu}c$+w2Nsc8=?nGk~>n6~Z#9uLS6!8+tAIm_}Ik4%q) zi#4MvuQ~4b2&+@^@s=a13|r7;BN#I0hkQ2;>vs_r4}wqga9;r-+QZOQIb(?Y3cp)X z`s^OuBcjpFFVCZeiHs}x+e)I};i*SEC(&%sB26kP>ivWL)R)_BMu-9rh8nS5)l~yX zF{Sw_+3%)AJd33>)Su`$c*1kc3btlKQTAnC&VN8HTXJ7XZb~*zHY~kPCvhk96AS^t z1W(!_RyW_aC*u^On#NRFpy<9OqY4#+P)vn5Pz?KcVLsE zaeP_KoXPG7|83w~U|Zz(`jieFsRWg86&21ZG#yO~q(WQ?`3Un`E8r@EW!|mhe5SJ; z;#y)JeJ)1)Nz<>ycdi?6#~!Ak+^rnDGSTnU*0 -
Digital Convergence Initiative
API docs by Redocly
Digital Convergence Initiative
API docs by Redocly
500

HTTP layer error details

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/registry/subscribe

Subscribe to a life event with registry

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/on-search

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/registry/subscribe

Subscribe to a life event with registry

Authorizations:
Authorization
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

required
SubscribeRequest (object) or EncryptedMessage (object)

Subscription request which contaion query with frequency and other info on which notification to be sent by registry to subscriber, The IBR supports benefit_disbusrement,programme_exited events as of now

@@ -530,7 +530,7 @@

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/registry/txn/status

Perform async status check of previous civil registry transanctions using transaction_id and/or reference_id(s)

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/on-notify

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/registry/txn/status

Perform async status check of previous civil registry transanctions using transaction_id and/or reference_id(s)

Authorizations:
Authorization
Request Body schema:
signature
string (MsgSignature)

Signature of {header}+{message} body verified using sender's signing public key

required
object

Message header

required
TxnStatusRequest (object) or EncryptedMessage (object)

Responses

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Sync

Sync endpoints

+
https://sandbox.spdci.org/namespace/v1.0.0/registry/txn/on-status

Request samples

Content type
{
  • "signature": "Signature: namespace=\"g2p\", kidId=\"{sender_id}|{unique_key_id}|{algorithm}\", algorithm=\"ed25519\", created=\"1606970629\", expires=\"1607030629\", headers=\"(created) (expires) digest\", signature=\"Base64(signing content)",
  • "header": {
    },
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Sync

Sync endpoints

SubscribeRequest

transaction_id
required
string <= 99 characters
    +
required
Array of objects
{
  • "transaction_id": 123456789,
  • "correlation_id": "9876543210",
  • "search_response": [
    ]
}

SubscribeRequest

transaction_id
required
string <= 99 characters
  1. transaction_id set by txn initiating system (i.e sender) to co-relate all related requests in the context of a business transaction.
  2. transaction_id should be samme across processing systems/service end points.
  3. transaction_id uniqueness is ensured by txn initiating system (i.e sender)
    4. @@ -621,7 +621,7 @@
  4. Register - It indi
  5. Deregister - If receipt is for a programme exit then programm information with suspended date to be recorded
-
{
  • "transaction_id": 123456789,
  • "receipt_information": {
    }
}

ReceiptResponse

transaction_id
required
string <= 99 characters
    +
{
  • "transaction_id": 123456789,
  • "receipt_information": {
    }
}

ReceiptResponse

transaction_id
required
string <= 99 characters
  1. transaction_id set by txn initiating system (i.e sender) to co-relate all related requests in the context of a business transaction.
  2. transaction_id should be samme across processing systems/service end points.
  3. transaction_id uniqueness is ensured by txn initiating system (i.e sender)
    4. @@ -631,7 +631,7 @@
  4. Register - It indi
  5. Deregister - If receipt is for a programme exit then programm information with suspended date to be recorded
-
{
  • "transaction_id": 123456789,
  • "receipt_information": {
    }
}

TxnStatusRequest

transaction_id
required
string <= 99 characters
    +
{
  • "transaction_id": 123456789,
  • "receipt_information": {
    }
}

TxnStatusRequest

transaction_id
required
string <= 99 characters
  1. transaction_id set by txn initiating system (i.e sender) to co-relate all related requests in the context of a business transaction.
  2. transaction_id should be samme across processing systems/service end points.
  3. transaction_id uniqueness is ensured by txn initiating system (i.e sender)
    4. @@ -645,7 +645,7 @@
  4. correlation_id acknowledged by end txn processing system (i.e receiver) to co-relate all related requests in the context of a business transaction.
  5. correlation_id uniqueness is ensured by txn processing system (i.e receiver)
-
required
object
{
  • "transaction_id": 123456789,
  • "correlation_id": "9876543210",
  • "txnstatus_response": {
    }
}

NotifyEventRequest

transaction_id
required
string <= 99 characters
    +
required
object
{
  • "transaction_id": 123456789,
  • "correlation_id": "9876543210",
  • "txnstatus_response": {
    }
}

NotifyEventRequest

transaction_id
required
string <= 99 characters
  1. transaction_id set by txn initiating system (i.e sender) to co-relate all related requests in the context of a business transaction.
  2. transaction_id should be samme across processing systems/service end points.
  3. transaction_id uniqueness is ensured by txn initiating system (i.e sender)
    4. @@ -680,7 +680,7 @@
{
  • "header": {
    },
  • "ciphertext": "string",
  • "encrypted_key": "string",
  • "tag": "string",
  • "iv": "string"
}

SearchStatusReasonCode

string (SearchStatusReasonCode)
Enum: "rjct.reference_id.invalid" "rjct.reference_id.duplicate" "rjct.timestamp.invalid" "rjct.search_criteria.invalid" "rjct.filter.invalid" "rjct.sort.invalid" "rjct.pagination.invalid" "rjct.search.too_many_records_found"

Identity verification request status reason codes

"rjct.reference_id.invalid"