Verification Detail
Verification details represent any information needed by GoCardless to verify a creditor.
Restricted: These endpoints are restricted to customers who want to collect their merchant's verification details and pass them to GoCardless via our API. Please get in touch if you wish to enable this feature on your account.
Create a verification detail#
/verification_detailsCreates a new verification detail
Request Body
verification_detailsobject10 properties
namestring
The company's legal name.
company_numberstring
The company's registration number.
descriptionstring
A summary describing what the company does.
address_line1string
The first line of the company's address.
address_line2string
The second line of the company's address.
address_line3string
The third line of the company's address.
citystring
The city of the company's address.
postal_codestring
The company's postal code.
directorsarray
The company's directors.
7 properties
given_namestring
The person's given name.
family_namestring
The person's family name.
date_of_birthstring
The person's date of birth.
streetstring
The street of the person's address.
citystring
The city of the person's address.
postal_codestring
The person's postal code.
country_codestring
linksobject
1 properties
creditorstring
ID of the associated creditor.
Response 201
Resource created successfully
verification_detailsobject12 properties
namestring
The company's legal name.
company_numberstring
The company's registration number.
descriptionstring
A summary describing what the company does.
address_line1string
The first line of the company's address.
address_line2string
The second line of the company's address.
address_line3string
The third line of the company's address.
citystring
The city of the company's address.
postal_codestring
The company's postal code.
regionstring
The region of the company's address.
country_codestring
The country code of the company's address.
directorsarray
The company's directors.
7 properties
given_namestring
The person's given name.
family_namestring
The person's family name.
date_of_birthstring
The person's date of birth.
streetstring
The street of the person's address.
citystring
The city of the person's address.
postal_codestring
The person's postal code.
country_codestring
linksobject
1 properties
creditorstring
ID of the creditor
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
codeintegerdocumentation_urlstringerrorsarray2 properties
reasonstringmessagestringmessagestringrequest_idstringtypestringmetadataobjectlinksobjectList verification details#
/verification_detailsReturns a list of verification details belonging to a creditor.
Response 200
Successful response
verification_detailsarray12 properties
namestring
The company's legal name.
company_numberstring
The company's registration number.
descriptionstring
A summary describing what the company does.
address_line1string
The first line of the company's address.
address_line2string
The second line of the company's address.
address_line3string
The third line of the company's address.
citystring
The city of the company's address.
postal_codestring
The company's postal code.
regionstring
The region of the company's address.
country_codestring
The country code of the company's address.
directorsarray
The company's directors.
7 properties
given_namestring
The person's given name.
family_namestring
The person's family name.
date_of_birthstring
The person's date of birth.
streetstring
The street of the person's address.
citystring
The city of the person's address.
postal_codestring
The person's postal code.
country_codestring
linksobject
1 properties
creditorstring
ID of the creditor
metaobject2 properties
limitintegercursorsobject
2 properties
beforestring
Cursor pointing to the end of the desired set.
afterstring
Cursor pointing to the start of the desired set.
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
codeintegerdocumentation_urlstringerrorsarray2 properties
reasonstringmessagestringmessagestringrequest_idstringtypestringmetadataobjectlinksobject