Verification Detail
Verification details represent any information needed by GoCardless to verify a creditor.
Create a verification detail#
/verification_detailsCreates a new verification detail
Request Body
verification_detailsobject10 properties
namestringrequired
The company's legal name.
company_numberstringrequired
The company's registration number.
descriptionstringrequired
A summary describing what the company does.
address_line1stringrequired
The first line of the company's address.
address_line2string | null
The second line of the company's address.
address_line3string | null
The third line of the company's address.
citystringrequired
The city of the company's address.
postal_codestringrequired
The company's postal code.
directorsarrayrequired
The company's directors.
7 properties
given_namestringrequired
The person's given name.
family_namestringrequired
The person's family name.
date_of_birthstringrequired
The person's date of birth.
streetstringrequired
The street of the person's address.
citystringrequired
The city of the person's address.
postal_codestringrequired
The person's postal code.
country_codestringrequired
linksobjectrequired
1 properties
creditorstringrequired
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 | null
The second line of the company's address.
address_line3string | null
The third line of the company's address.
citystring
The city of the company's address.
postal_codestring
The company's postal code.
regionstring | null
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_namestringrequired
The person's given name.
family_namestringrequired
The person's family name.
date_of_birthstringrequired
The person's date of birth.
streetstringrequired
The street of the person's address.
citystringrequired
The city of the person's address.
postal_codestringrequired
The person's postal code.
country_codestringrequired
linksobject
1 properties
creditorstring
ID of the creditor
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
errorobjectrequiredGeneric error
6 properties
codeintegerdocumentation_urlstringerrorsarrayrequired
6 properties
reasonstringfieldstringrequest_pointerstringmessagestringrequiredmetadataobjectlinksobjectmessagestringrequiredrequest_idstringrequiredtypestringList verification details#
/verification_detailsReturns a list of verification details belonging to a creditor.
Query Parameters
| Name | Type | Description |
|---|---|---|
before | string | null | Cursor pointing to the end of the desired set. |
after | string | null | Cursor pointing to the start of the desired set. |
limit | integer | string | Number of records to return. |
creditor | stringrequired |
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 | null
The second line of the company's address.
address_line3string | null
The third line of the company's address.
citystring
The city of the company's address.
postal_codestring
The company's postal code.
regionstring | null
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_namestringrequired
The person's given name.
family_namestringrequired
The person's family name.
date_of_birthstringrequired
The person's date of birth.
streetstringrequired
The street of the person's address.
citystringrequired
The city of the person's address.
postal_codestringrequired
The person's postal code.
country_codestringrequired
linksobject
1 properties
creditorstring
ID of the creditor
metaobject2 properties
limitintegerrequiredcursorsobjectrequired
2 properties
beforestring | nullrequired
Cursor pointing to the end of the desired set.
afterstring | nullrequired
Cursor pointing to the start of the desired set.
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
errorobjectrequiredGeneric error
6 properties
codeintegerdocumentation_urlstringerrorsarrayrequired
6 properties
reasonstringfieldstringrequest_pointerstringmessagestringrequiredmetadataobjectlinksobjectmessagestringrequiredrequest_idstringrequiredtypestring