Support

Update a manual KYB record

PATCH /kyb/manual/{kybId}

Parameters

kybId string Required path

The unique ID of the current KYB record for an entity. Same as currentKybId on the entity object.

x-tenant-id string Required header

Tenant identifier. Required on all tenant-scoped routes.

More parameters Expand all

countryName string

No description.

countryCode string

No description.

registrationNumber string

No description.

jurisdictionCode string

No description.

companyName string

No description.

kybFormData object

No description.

vendorData object

No description.

vendor enum

No description.

Possible values: shufti_promanualcompilot

submissionCompleted boolean

No description.

verificationStatus enum

No description.

Possible values: pendingapprovedresubmissionrejected

reason string

No description.

id string

The unique ID of the resource being addressed. See the id field in the parent resource's list or GET-by-ID response.

decisionTime timestamp

No description.

createdAt timestamp

No description.

updatedAt timestamp

No description.

PATCH /kyb/manual/{kybId}

curl -X PATCH "https://heimdall.qa.zoniqx.com/kyb/manual/<kybId>" \
  -H "Authorization: Bearer <accessToken>" \
  -H "x-tenant-id: <your-tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
      "countryName": "string",
      "countryCode": "string",
      "registrationNumber": "string",
      "jurisdictionCode": "string",
      "companyName": "string",
      "kybFormData": {
        "kybType": "kyb",
        "compliances": [
          {
            "condition": {
              "condition": "string",
              "checked": true
            },
            "description": "string"
          }
        ],
        "clientInformation": {
          "entityName": "string",
          "tradeName": "string",
          "legalStatus": "sole_proprietorship",
          "legalStatusOther": "string",
          "placeOfIncorporation": "string",
          "dateOfIncorporation": "string",
          "countryOfOperation": "string",
          "licenseNumber": "string",
          "licenseIssueDate": "string",
          "licenseExpiryDate": "string",
          "licenseIssuingAuthority": "string",
          "registrationNumber": "string",
          "vatRegistrationNumber": "string",
          "mainLicensedActivity": "string",
          "registeredAddress": "string",
          "contactPerson": {
            "name": "string",
            "phoneNumber": "string",
            "mobileNumber": "string",
            "designation": "string",
            "email": "user@example.com"
          },
          "communicationType": "face_to_face"
        },
        "ownershipAndControl": {
          "owners": [
            {
              "fullLegalName": "string",
              "nationality": "string",
              "countryOfRegistration": "string",
              "countryOfResidence": "string",
              "shareholdingPercentage": 0
            }
          ]
        },
        "managementDetails": {
          "directorsAndManagement": [
            {
              "fullName": "string",
              "designation": "string",
              "nationality": "string",
              "countryOfResidence": "string"
            }
          ]
        },
        "sourceOfFundsAndWealth": {
          "sourceOfFunds": {
            "types": [
              "business_income"
            ],
            "otherDescription": "string"
          },
          "sourceOfWealth": {
            "types": [
              "business_income"
            ],
            "otherDescription": "string"
          },
          "countryOfOriginOfFunds": "string"
        },
        "pepDetails": {
          "isPep": true,
          "pepInfo": {
            "name": "string",
            "positionOrRole": "string",
            "relationshipToEntity": "string",
            "countryOfPublicFunction": "string"
          },
          "hasRelatedPep": true,
          "relatedPepInfo": {
            "name": "string",
            "relationshipToEntity": "string",
            "positionOrRole": "string",
            "countryOfPublicFunction": "string"
          }
        },
        "servicesRequested": {
          "services": [
            "fund_management"
          ],
          "otherServiceDescription": "string",
          "relationshipPurpose": "string"
        },
        "documentsProvided": {
          "commercialLicense": "string",
          "certificateOfIncorporation": "string",
          "incumbencyOrShareRegister": "string",
          "moaAoa": "string",
          "trustDeed": "string",
          "foundationCharter": "string",
          "passportsOfUBOs": [
            "string"
          ],
          "proofOfAddress": "string",
          "vatCertificate": "string",
          "structureChart": "string",
          "poaIfApplicable": "string",
          "commercialLicenseAndCertificateOfIncorporation": [
            "string"
          ],
          "additionalDocuments": [
            "string"
          ]
        },
        "clientDeclaration": {
          "fullName": "string",
          "designation": "string",
          "companyName": "string",
          "signedAt": "string",
          "signatureAccepted": true
        }
      },
      "vendorData": {
        "verification": null,
        "technicalData": {
          "ip": "string"
        }
      },
      "vendor": "shufti_pro",
      "submissionCompleted": false,
      "verificationStatus": "pending",
      "reason": "string",
      "id": "string",
      "decisionTime": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }'

const response = await fetch("https://heimdall.qa.zoniqx.com/kyb/manual/<kybId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <accessToken>",
    "x-tenant-id": "<your-tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "countryName": "string",
    "countryCode": "string",
    "registrationNumber": "string",
    "jurisdictionCode": "string",
    "companyName": "string",
    "kybFormData": {
      "kybType": "kyb",
      "compliances": [
        {
          "condition": {
            "condition": "string",
            "checked": true
          },
          "description": "string"
        }
      ],
      "clientInformation": {
        "entityName": "string",
        "tradeName": "string",
        "legalStatus": "sole_proprietorship",
        "legalStatusOther": "string",
        "placeOfIncorporation": "string",
        "dateOfIncorporation": "string",
        "countryOfOperation": "string",
        "licenseNumber": "string",
        "licenseIssueDate": "string",
        "licenseExpiryDate": "string",
        "licenseIssuingAuthority": "string",
        "registrationNumber": "string",
        "vatRegistrationNumber": "string",
        "mainLicensedActivity": "string",
        "registeredAddress": "string",
        "contactPerson": {
          "name": "string",
          "phoneNumber": "string",
          "mobileNumber": "string",
          "designation": "string",
          "email": "user@example.com"
        },
        "communicationType": "face_to_face"
      },
      "ownershipAndControl": {
        "owners": [
          {
            "fullLegalName": "string",
            "nationality": "string",
            "countryOfRegistration": "string",
            "countryOfResidence": "string",
            "shareholdingPercentage": 0
          }
        ]
      },
      "managementDetails": {
        "directorsAndManagement": [
          {
            "fullName": "string",
            "designation": "string",
            "nationality": "string",
            "countryOfResidence": "string"
          }
        ]
      },
      "sourceOfFundsAndWealth": {
        "sourceOfFunds": {
          "types": [
            "business_income"
          ],
          "otherDescription": "string"
        },
        "sourceOfWealth": {
          "types": [
            "business_income"
          ],
          "otherDescription": "string"
        },
        "countryOfOriginOfFunds": "string"
      },
      "pepDetails": {
        "isPep": true,
        "pepInfo": {
          "name": "string",
          "positionOrRole": "string",
          "relationshipToEntity": "string",
          "countryOfPublicFunction": "string"
        },
        "hasRelatedPep": true,
        "relatedPepInfo": {
          "name": "string",
          "relationshipToEntity": "string",
          "positionOrRole": "string",
          "countryOfPublicFunction": "string"
        }
      },
      "servicesRequested": {
        "services": [
          "fund_management"
        ],
        "otherServiceDescription": "string",
        "relationshipPurpose": "string"
      },
      "documentsProvided": {
        "commercialLicense": "string",
        "certificateOfIncorporation": "string",
        "incumbencyOrShareRegister": "string",
        "moaAoa": "string",
        "trustDeed": "string",
        "foundationCharter": "string",
        "passportsOfUBOs": [
          "string"
        ],
        "proofOfAddress": "string",
        "vatCertificate": "string",
        "structureChart": "string",
        "poaIfApplicable": "string",
        "commercialLicenseAndCertificateOfIncorporation": [
          "string"
        ],
        "additionalDocuments": [
          "string"
        ]
      },
      "clientDeclaration": {
        "fullName": "string",
        "designation": "string",
        "companyName": "string",
        "signedAt": "string",
        "signatureAccepted": true
      }
    },
    "vendorData": {
      "verification": null,
      "technicalData": {
        "ip": "string"
      }
    },
    "vendor": "shufti_pro",
    "submissionCompleted": false,
    "verificationStatus": "pending",
    "reason": "string",
    "id": "string",
    "decisionTime": "2024-01-15T10:30:00Z",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }),
});

const data = await response.json();

type KybController_updateManualKybResponse = Record<string, unknown>;

const response = await fetch("https://heimdall.qa.zoniqx.com/kyb/manual/<kybId>", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer <accessToken>",
    "x-tenant-id": "<your-tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "countryName": "string",
    "countryCode": "string",
    "registrationNumber": "string",
    "jurisdictionCode": "string",
    "companyName": "string",
    "kybFormData": {
      "kybType": "kyb",
      "compliances": [
        {
          "condition": {
            "condition": "string",
            "checked": true
          },
          "description": "string"
        }
      ],
      "clientInformation": {
        "entityName": "string",
        "tradeName": "string",
        "legalStatus": "sole_proprietorship",
        "legalStatusOther": "string",
        "placeOfIncorporation": "string",
        "dateOfIncorporation": "string",
        "countryOfOperation": "string",
        "licenseNumber": "string",
        "licenseIssueDate": "string",
        "licenseExpiryDate": "string",
        "licenseIssuingAuthority": "string",
        "registrationNumber": "string",
        "vatRegistrationNumber": "string",
        "mainLicensedActivity": "string",
        "registeredAddress": "string",
        "contactPerson": {
          "name": "string",
          "phoneNumber": "string",
          "mobileNumber": "string",
          "designation": "string",
          "email": "user@example.com"
        },
        "communicationType": "face_to_face"
      },
      "ownershipAndControl": {
        "owners": [
          {
            "fullLegalName": "string",
            "nationality": "string",
            "countryOfRegistration": "string",
            "countryOfResidence": "string",
            "shareholdingPercentage": 0
          }
        ]
      },
      "managementDetails": {
        "directorsAndManagement": [
          {
            "fullName": "string",
            "designation": "string",
            "nationality": "string",
            "countryOfResidence": "string"
          }
        ]
      },
      "sourceOfFundsAndWealth": {
        "sourceOfFunds": {
          "types": [
            "business_income"
          ],
          "otherDescription": "string"
        },
        "sourceOfWealth": {
          "types": [
            "business_income"
          ],
          "otherDescription": "string"
        },
        "countryOfOriginOfFunds": "string"
      },
      "pepDetails": {
        "isPep": true,
        "pepInfo": {
          "name": "string",
          "positionOrRole": "string",
          "relationshipToEntity": "string",
          "countryOfPublicFunction": "string"
        },
        "hasRelatedPep": true,
        "relatedPepInfo": {
          "name": "string",
          "relationshipToEntity": "string",
          "positionOrRole": "string",
          "countryOfPublicFunction": "string"
        }
      },
      "servicesRequested": {
        "services": [
          "fund_management"
        ],
        "otherServiceDescription": "string",
        "relationshipPurpose": "string"
      },
      "documentsProvided": {
        "commercialLicense": "string",
        "certificateOfIncorporation": "string",
        "incumbencyOrShareRegister": "string",
        "moaAoa": "string",
        "trustDeed": "string",
        "foundationCharter": "string",
        "passportsOfUBOs": [
          "string"
        ],
        "proofOfAddress": "string",
        "vatCertificate": "string",
        "structureChart": "string",
        "poaIfApplicable": "string",
        "commercialLicenseAndCertificateOfIncorporation": [
          "string"
        ],
        "additionalDocuments": [
          "string"
        ]
      },
      "clientDeclaration": {
        "fullName": "string",
        "designation": "string",
        "companyName": "string",
        "signedAt": "string",
        "signatureAccepted": true
      }
    },
    "vendorData": {
      "verification": null,
      "technicalData": {
        "ip": "string"
      }
    },
    "vendor": "shufti_pro",
    "submissionCompleted": false,
    "verificationStatus": "pending",
    "reason": "string",
    "id": "string",
    "decisionTime": "2024-01-15T10:30:00Z",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }),
});

const data: KybController_updateManualKybResponse = await response.json();

import requests

url = "https://heimdall.qa.zoniqx.com/kyb/manual/<kybId>"

headers = {
    "Authorization": "Bearer <accessToken>",
    "x-tenant-id": "<your-tenant-id>",
}

payload = {
    "countryName": "string",
    "countryCode": "string",
    "registrationNumber": "string",
    "jurisdictionCode": "string",
    "companyName": "string",
    "kybFormData": {
        "kybType": "kyb",
        "compliances": [
            {
                "condition": {
                    "condition": "string",
                    "checked": True
                },
                "description": "string"
            }
        ],
        "clientInformation": {
            "entityName": "string",
            "tradeName": "string",
            "legalStatus": "sole_proprietorship",
            "legalStatusOther": "string",
            "placeOfIncorporation": "string",
            "dateOfIncorporation": "string",
            "countryOfOperation": "string",
            "licenseNumber": "string",
            "licenseIssueDate": "string",
            "licenseExpiryDate": "string",
            "licenseIssuingAuthority": "string",
            "registrationNumber": "string",
            "vatRegistrationNumber": "string",
            "mainLicensedActivity": "string",
            "registeredAddress": "string",
            "contactPerson": {
                "name": "string",
                "phoneNumber": "string",
                "mobileNumber": "string",
                "designation": "string",
                "email": "user@example.com"
            },
            "communicationType": "face_to_face"
        },
        "ownershipAndControl": {
            "owners": [
                {
                    "fullLegalName": "string",
                    "nationality": "string",
                    "countryOfRegistration": "string",
                    "countryOfResidence": "string",
                    "shareholdingPercentage": 0
                }
            ]
        },
        "managementDetails": {
            "directorsAndManagement": [
                {
                    "fullName": "string",
                    "designation": "string",
                    "nationality": "string",
                    "countryOfResidence": "string"
                }
            ]
        },
        "sourceOfFundsAndWealth": {
            "sourceOfFunds": {
                "types": [
                    "business_income"
                ],
                "otherDescription": "string"
            },
            "sourceOfWealth": {
                "types": [
                    "business_income"
                ],
                "otherDescription": "string"
            },
            "countryOfOriginOfFunds": "string"
        },
        "pepDetails": {
            "isPep": True,
            "pepInfo": {
                "name": "string",
                "positionOrRole": "string",
                "relationshipToEntity": "string",
                "countryOfPublicFunction": "string"
            },
            "hasRelatedPep": True,
            "relatedPepInfo": {
                "name": "string",
                "relationshipToEntity": "string",
                "positionOrRole": "string",
                "countryOfPublicFunction": "string"
            }
        },
        "servicesRequested": {
            "services": [
                "fund_management"
            ],
            "otherServiceDescription": "string",
            "relationshipPurpose": "string"
        },
        "documentsProvided": {
            "commercialLicense": "string",
            "certificateOfIncorporation": "string",
            "incumbencyOrShareRegister": "string",
            "moaAoa": "string",
            "trustDeed": "string",
            "foundationCharter": "string",
            "passportsOfUBOs": [
                "string"
            ],
            "proofOfAddress": "string",
            "vatCertificate": "string",
            "structureChart": "string",
            "poaIfApplicable": "string",
            "commercialLicenseAndCertificateOfIncorporation": [
                "string"
            ],
            "additionalDocuments": [
                "string"
            ]
        },
        "clientDeclaration": {
            "fullName": "string",
            "designation": "string",
            "companyName": "string",
            "signedAt": "string",
            "signatureAccepted": True
        }
    },
    "vendorData": {
        "verification": None,
        "technicalData": {
            "ip": "string"
        }
    },
    "vendor": "shufti_pro",
    "submissionCompleted": False,
    "verificationStatus": "pending",
    "reason": "string",
    "id": "string",
    "decisionTime": "2024-01-15T10:30:00Z",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
}

response = requests.patch(url, headers=headers, json=payload)
data = response.json()

Try request

Authentication

Bearer token

x-tenant-id

Path parameters

kybId string required

Request body

{
  "countryName": "string",
  "countryCode": "string",
  "registrationNumber": "string",
  "jurisdictionCode": "string",
  "companyName": "string",
  "kybFormData": {
    "kybType": "kyb",
    "compliances": [
      {
        "condition": {
          "condition": "string",
          "checked": true
        },
        "description": "string"
      }
    ],
    "clientInformation": {
      "entityName": "string",
      "tradeName": "string",
      "legalStatus": "sole_proprietorship",
      "legalStatusOther": "string",
      "placeOfIncorporation": "string",
      "dateOfIncorporation": "string",
      "countryOfOperation": "string",
      "licenseNumber": "string",
      "licenseIssueDate": "string",
      "licenseExpiryDate": "string",
      "licenseIssuingAuthority": "string",
      "registrationNumber": "string",
      "vatRegistrationNumber": "string",
      "mainLicensedActivity": "string",
      "registeredAddress": "string",
      "contactPerson": {
        "name": "string",
        "phoneNumber": "string",
        "mobileNumber": "string",
        "designation": "string",
        "email": "user@example.com"
      },
      "communicationType": "face_to_face"
    },
    "ownershipAndControl": {
      "owners": [
        {
          "fullLegalName": "string",
          "nationality": "string",
          "countryOfRegistration": "string",
          "countryOfResidence": "string",
          "shareholdingPercentage": 0
        }
      ]
    },
    "managementDetails": {
      "directorsAndManagement": [
        {
          "fullName": "string",
          "designation": "string",
          "nationality": "string",
          "countryOfResidence": "string"
        }
      ]
    },
    "sourceOfFundsAndWealth": {
      "sourceOfFunds": {
        "types": [
          "business_income"
        ],
        "otherDescription": "string"
      },
      "sourceOfWealth": {
        "types": [
          "business_income"
        ],
        "otherDescription": "string"
      },
      "countryOfOriginOfFunds": "string"
    },
    "pepDetails": {
      "isPep": true,
      "pepInfo": {
        "name": "string",
        "positionOrRole": "string",
        "relationshipToEntity": "string",
        "countryOfPublicFunction": "string"
      },
      "hasRelatedPep": true,
      "relatedPepInfo": {
        "name": "string",
        "relationshipToEntity": "string",
        "positionOrRole": "string",
        "countryOfPublicFunction": "string"
      }
    },
    "servicesRequested": {
      "services": [
        "fund_management"
      ],
      "otherServiceDescription": "string",
      "relationshipPurpose": "string"
    },
    "documentsProvided": {
      "commercialLicense": "string",
      "certificateOfIncorporation": "string",
      "incumbencyOrShareRegister": "string",
      "moaAoa": "string",
      "trustDeed": "string",
      "foundationCharter": "string",
      "passportsOfUBOs": [
        "string"
      ],
      "proofOfAddress": "string",
      "vatCertificate": "string",
      "structureChart": "string",
      "poaIfApplicable": "string",
      "commercialLicenseAndCertificateOfIncorporation": [
        "string"
      ],
      "additionalDocuments": [
        "string"
      ]
    },
    "clientDeclaration": {
      "fullName": "string",
      "designation": "string",
      "companyName": "string",
      "signedAt": "string",
      "signatureAccepted": true
    }
  },
  "vendorData": {
    "verification": null,
    "technicalData": {
      "ip": "string"
    }
  },
  "vendor": "shufti_pro",
  "submissionCompleted": false,
  "verificationStatus": "pending",
  "reason": "string",
  "id": "string",
  "decisionTime": "2024-01-15T10:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Response · 200

{}