Skip to content

Commit

Permalink
updated response schema
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Fernandes authored and Ian Fernandes committed Mar 28, 2024
1 parent c36ca01 commit 8140e01
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
25 changes: 17 additions & 8 deletions api-references/data/okyc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,10 @@
"name": "Aditya Mohan",
"phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b",
"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==",
"userProfile": {
"unmaskedEmail": "[email protected]",
"unmaskedPhone": "1234567890"
},
"verified": {
"email": false,
"phone": false,
Expand Down Expand Up @@ -2047,15 +2051,15 @@
"name": "Aditya Mohan",
"phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b",
"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==",
"userProfile": {
"unmaskedPhone": "9876543210",
"unmaskedEmail": "[email protected]"
},
"verified": {
"email": false,
"phone": false,
"signature": true
},
"userProfile": {
"unmaskedPhone": "9876543210",
"unmaskedEmail": "[email protected]"
},
"xml": {
"fileUrl": "https://setus3linkgoeshere.com/",
"validUntil": 12345678
Expand All @@ -2076,6 +2080,7 @@
"name",
"phone",
"photo",
"userProfile",
"verified",
"xml"
],
Expand Down Expand Up @@ -2141,15 +2146,15 @@
"name": "Aditya Mohan",
"phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b",
"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==",
"userProfile": {
"unmaskedPhone": "9876543210",
"unmaskedEmail": "[email protected]"
},
"verified": {
"email": false,
"phone": false,
"signature": true
},
"userProfile": {
"unmaskedPhone": "9876543210",
"unmaskedEmail": "[email protected]"
},
"xml": {
"fileUrl": "https://setus3linkgoeshere.com/",
"validUntil": 12345678
Expand Down Expand Up @@ -2417,6 +2422,10 @@
"name": "Jignesh Gurjar",
"phone": "09c91184c1d610282d661dd63d257e3b44446853fb1388c9d5b",
"photo": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD==",
"userProfile": {
"unmaskedEmail": "[email protected]",
"unmaskedPhone": "1234567890"
},
"verified": {
"email": false,
"phone": false,
Expand Down
4 changes: 4 additions & 0 deletions content/data/okyc/api-integration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,8 @@ You may also let your customer receive a new OTP by calling the <strong>Verify O
<hr className="tertiary" />
<h5>Response</h5>
<p>If the value of the <code>shareCode</code> is incorrect, the <code>status</code> associated with this OKYC request <code>id</code> will remain in <code>incomplete</code> state. Please retry the API to move the <code>status</code> to <code>complete</code>.</p>
<p>If the unmasked phone and email of the user are available from UIDAI, we return it in the <code>userProfile</code> field of the response. <code>userProfile</code> contains
two fields, <code>unmaskedPhone</code> and <code>unmaskedEmail</code>. </p>
<CodeBlockWithCopy language="json">
{`{
"aadhaar": {
Expand Down Expand Up @@ -696,6 +698,8 @@ Possible values for `status`, received as part of the response—
all customer KYC details included in the XML, and the URL for
the zip file.
</p>
<p>If the unmasked phone and email of the user are available from UIDAI, we return it in the <code>userProfile</code> field of the response. <code>userProfile</code> contains
two fields, <code>unmaskedPhone</code> and <code>unmaskedEmail</code>. </p>
<CodeBlockWithCopy language="json">
{`{
"aadhaar": {
Expand Down

0 comments on commit 8140e01

Please sign in to comment.